Changes for page Part VI. Registry Namespace

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,6 +1,7 @@
1	1	{{box title="**Contents**"}}
2	2	{{toc/}}
3	3	{{/box}}
	4	+
4	4
5	5	= 1. Introduction =
6	6
...	...	@@ -9,7 +9,6 @@
9	9	As was done with the query, the registry message set now contains distinct messages for each operation. The messages will eventually allow the registry to function in more standard web service mannter.
10	10
11	11	= 2. Schema Documentation =
12		-
13	13	== 2.1 Registry Namespace ==
14	14
15	15	**http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/registry**
...	...	@@ -17,7 +17,6 @@
17	17	=== 2.1.1 Summary ===
18	18
19	19	Referenced Namespaces:
20		-
21	21	|**Namespace**|**Prefix**
22	22	|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
23	23	|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure|str
...	...	@@ -38,7 +38,6 @@
38	38	ProvisionAgreement, Datasource
39	39
40	40	Attribute Documentation:
41		-
42	42	|**Name**|**Type**|**Documentation**
43	43	|id|com:IDType|The id attribute holds a registry assigned identification for the registration. This must be provided in a response message (unless an error occurred while submitting a new registration), and should be included when updating or deleting a registration.
44	44	|validFrom|xs:dateTime|The validFrom attribute provides an inclusive start date for providing supplemental validity information about the registration, so that data visibility from the registry can be controlled by the registrant.
...	...	@@ -50,7 +50,6 @@
50	50	|indexReportingPeriod (default: false)|xs:boolean|The indexReportingPeriod, if true, indicates that the registry must index the time period ranges for which data is present for the data source. The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.
51	51
52	52	Element Documentation:
53		-
54	54	|**Name**|**Type**|**Documentation**
55	55	|ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreement provides a reference to the provision agreement that the data is being registered against.
56	56	|Datasource|DataSourceType|Datasource identifies the data source(s) where the registered data can be retrieved.
...	...	@@ -61,7 +61,6 @@
61	61	(SimpleDataSource | QueryableDataSource)[1..2]
62	62
63	63	Element Documentation:
64		-
65	65	|**Name**|**Type**|**Documentation**
66	66	|SimpleDataSource|xs:anyURI|SimpleDatasource describes a data source that is an SDMX-ML data or metadata message. It requires only the URL of the data.
67	67	|QueryableDataSource|QueryableDataSourceT ype|QueryableDatasource describes a data source that must be able to accept an SDMX-ML Query Message, and respond appropriately.
...	...	@@ -69,7 +69,6 @@
69	69	**SimpleDataSourceType: **SimpleDataSourceType describes a simple data source. The URL of the data is contained in the content.
70	70
71	71	Derivation:
72		-
73	73	* xs:anySimpleType (restriction)
74	74	** xs:anyURI (extension)
75	75	*** SimpleDataSourceType
...	...	@@ -86,7 +86,6 @@
86	86	**QueryableDataSourceType: **QueryableDataSourceType describes a queryable data source, and add a fixed attribute for ensuring only one queryable source can be provided.
87	87
88	88	Derivation:
89		-
90	90	* com:QueryableDataSourceType (extension)
91	91	** QueryableDataSourceType
92	92
...	...	@@ -97,7 +97,6 @@
97	97	com:DataURL, com:WSDLURL?, com:WADLURL?
98	98
99	99	Attribute Documentation:
100		-
101	101	|**Name**|**Type**|**Documentation**
102	102	|isRESTDatasource|xs:boolean|The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
103	103	|isWebServiceDatasource|xs:boolean|The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
...	...	@@ -104,7 +104,6 @@
104	104	|TYPE (fixed: QUERY)|xs:string|TYPE is a fixed attribute that is used to ensure only one queryable data source may be provided, when it is referenced in a uniqueness constraint.
105	105
106	106	Element Documentation:
107		-
108	108	|**Name**|**Type**|**Documentation**
109	109	|com:DataURL|xs:anyURI|DataURL contains the URL of the data source.
110	110	|com:WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
...	...	@@ -119,7 +119,6 @@
119	119	{Empty}
120	120
121	121	Attribute Documentation:
122		-
123	123	|**Name**|**Type**|**Documentation**
124	124	|id (default: %)|IDQueryType|The id attribute is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.
125	125
...	...	@@ -126,7 +126,6 @@
126	126	**VersionableQueryType: **VersionableQueryType describes the structure of a query for a versionable object.
127	127
128	128	Derivation:
129		-
130	130	* IdentifiableQueryType (extension)
131	131	** VersionableQueryType
132	132
...	...	@@ -137,7 +137,6 @@
137	137	{Empty}
138	138
139	139	Attribute Documentation:
140		-
141	141	|**Name**|**Type**|**Documentation**
142	142	|id (default: %)|IDQueryType|The id attribute is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.
143	143	|version (default: *)|VersionQueryType|The version attribute is used to query for an object based on its version. This can be and explicit value, wild-carded ("%"), or late-bound ("*"). A wild carded version will match any version of the object where as a late-bound version will only match the latest version.
...	...	@@ -146,14 +146,16 @@
146	146
147	147	Derivation:
148	148
149		-* IdentifiableQueryType (extension)
150		-** VersionableQueryType (extension)
151		-*** MaintainableQueryType
	138	+IdentifiableQueryType (extension)
	139	+ [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] VersionableQueryType (extension)
	140	+ [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] MaintainableQueryType
152	152
153	153	Attributes:
	143	+
154	154	id?, version?, agencyID?
155	155
156	156	Content:
	147	+
157	157	{Empty}
158	158
159	159	Attribute Documentation:
...	...	@@ -166,9 +166,11 @@
166	166	**StatusMessageType: **StatusMessageType carries the text of error messages and/or warnings in response to queries or requests.
167	167
168	168	Attributes:
	160	+
169	169	status
170	170
171	171	Content:
	164	+
172	172	MessageText*
173	173
174	174	Attribute Documentation:
...	...	@@ -184,6 +184,7 @@
184	184	**SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of data/metadata set registrations.
185	185
186	186	Content:
	180	+
187	187	RegistrationRequest+
188	188
189	189	Element Documentation:
...	...	@@ -194,9 +194,11 @@
194	194	**RegistrationRequestType: **RegistrationRequestType describes the structure of a single registration request. It contains the details of a registation and an action field to indicate the action to be taken on the contained registration.
195	195
196	196	Attributes:
	191	+
197	197	action
198	198
199	199	Content:
	195	+
200	200	Registration
201	201
202	202	Attribute Documentation:
...	...	@@ -212,6 +212,7 @@
212	212	**SubmitRegistrationsResponseType: **SubmitRegistrationsResponseType describes the structure of a registration response. For each submitted registration in the request, a registration status is provided. The status elements should be provided in the same order as the submitted registrations, although each status will echo the request to ensure accurate processing of the responses.
213	213
214	214	Content:
	211	+
215	215	RegistrationStatus+
216	216
217	217	Element Documentation:
...	...	@@ -222,6 +222,7 @@
222	222	**RegistrationStatusType: **RegistrationStatusType describes the structure of a registration status.
223	223
224	224	Content:
	222	+
225	225	Registration, StatusMessage
226	226
227	227	Element Documentation:
...	...	@@ -233,9 +233,11 @@
233	233	**QueryRegistrationRequestType: **QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, reference metadata, or both) must be specified. It is possible to query for registrations for a particular provision agreement, data provider, or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing constraints in the form of explicit time periods, constraint regions, and key sets. When constraint regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions.
234	234
235	235	Attributes:
	234	+
236	236	returnConstraints?
237	237
238	238	Content:
	238	+
239	239	QueryType, (All | ProvisionAgreement | DataProvider | Dataflow | Metadataflow), ReferencePeriod?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*
240	240
241	241	Attribute Documentation:
...	...	@@ -261,6 +261,7 @@
261	261	**QueryRegistrationResponseType: **QueryRegistrationResponseType describes the structure of a registration query response. It provides a status for the request, and if successful, the resulting data and/or metadata results.
262	262
263	263	Content:
	264	+
264	264	StatusMessage, QueryResult*
265	265
266	266	Element Documentation:
...	...	@@ -272,9 +272,11 @@
272	272	**QueryResultType: **QueryResultType describes the structure of a query result for a single data source. Either a data result or metadata result is detailed, depending on the data source.
273	273
274	274	Attributes:
	276	+
275	275	timeSeriesMatch
276	276
277	277	Content:
	280	+
278	278	(DataResult | MetadataResult)
279	279
280	280	Attribute Documentation:
...	...	@@ -291,6 +291,7 @@
291	291	**ResultType: **ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content constraints for the data source may be provided, if the query requested this information.
292	292
293	293	Content:
	297	+
294	294	Registration, ContentConstraint*
295	295
296	296	Element Documentation:
...	...	@@ -302,9 +302,11 @@
302	302	**SubmitStructureRequestType: **SubmitStructureRequestType describes the structure of a structure submission. Structural components are provided either in-line or referenced via a SDMX-ML Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained components, but can be overridden on a per component basis.
303	303
304	304	Attributes:
	309	+
305	305	action?, externalDependencies?
306	306
307	307	Content:
	313	+
308	308	(StructureLocation | str:Structures), SubmittedStructure*
309	309
310	310	Attribute Documentation:
...	...	@@ -323,9 +323,11 @@
323	323	**SubmittedStructureType: **SubmittedStructureType generally references a submitted structural object. When used in a submit structure request, its purpose is to override the default action or external dependency resolution behavior. If neither of these indicators are set, then it will be ignored. In a submit structure response, it is used to reference a submitted object for the purpose of providing a status for the submission. In this case, the action attribute should be populated in order to echo the requested action.
324	324
325	325	Attributes:
	332	+
326	326	action?, externalDependencies?
327	327
328	328	Content:
	336	+
329	329	MaintainableObject
330	330
331	331	Attribute Documentation:
...	...	@@ -342,6 +342,7 @@
342	342	**SubmitStructureResponseType: **SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.
343	343
344	344	Content:
	353	+
345	345	SubmissionResult+
346	346
347	347	Element Documentation:
...	...	@@ -352,6 +352,7 @@
352	352	**SubmissionResultType: **SubmissionResultType provides the status of the structural object submission request. It will identify the object submitted, report back the action requested, and convey the status and any error messages which are relevant to the submission.
353	353
354	354	Content:
	364	+
355	355	SubmittedStructure, StatusMessage
356	356
357	357	Element Documentation:
...	...	@@ -363,6 +363,7 @@
363	363	**SubmitSubscriptionsRequestType: **SubmitSubscriptionsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of subscriptions. Subscriptions are submitted to the registry to subscribe to registration and change events for specific registry resources.
364	364
365	365	Content:
	376	+
366	366	SubscriptionRequest+
367	367
368	368	Element Documentation:
...	...	@@ -373,6 +373,7 @@
373	373	**SubscriptionType: **SubscriptionType describes the details of a subscription to a registration or change event for registry resources. When it occurs as the content of a response message, the registry URN must be provide, unless the response is a failure notification for the creation of a new subscription.
374	374
375	375	Content:
	387	+
376	376	Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector
377	377
378	378	Element Documentation:
...	...	@@ -389,9 +389,11 @@
389	389	**SubscriptionRequestType: **SubscriptionRequestType describes the structure of a single subscription request. It contains subscription details and an action field to indicate the action to be taken on the contained subscription. Note that if the action is update or delete, then the registry supplied URN for the subscription must be included.
390	390
391	391	Attributes:
	404	+
392	392	action
393	393
394	394	Content:
	408	+
395	395	Subscription
396	396
397	397	Attribute Documentation:
...	...	@@ -407,6 +407,7 @@
407	407	**SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request.
408	408
409	409	Content:
	424	+
410	410	SubscriptionStatus+
411	411
412	412	Element Documentation:
...	...	@@ -417,6 +417,7 @@
417	417	**SubscriptionStatusType: **SubscriptionStatusType describes the structure a status for a single subscription request.
418	418
419	419	Content:
	435	+
420	420	SubscriptionURN?, SubscriberAssignedID?, StatusMessage
421	421
422	422	Element Documentation:
...	...	@@ -429,6 +429,7 @@
429	429	**QuerySubscriptionRequestType: **QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.
430	430
431	431	Content:
	448	+
432	432	Organisation
433	433
434	434	Element Documentation:
...	...	@@ -439,6 +439,7 @@
439	439	**QuerySubscriptionResponseType: **QuerySubscriptionResponseType describes the structure of a subscription query response. A status will describe the success or failure of the request (and provide error or warning messages if necessary). If the query was successful, details of all of the organisation's subscriptions will be provided.
440	440
441	441	Content:
	459	+
442	442	StatusMessage, Subscription*
443	443
444	444	Element Documentation:
...	...	@@ -450,6 +450,7 @@
450	450	**NotifyRegistryEventType: **NotifyRegistryEventType describes the structure a registry notification, in response to a subscription to a registry event. At a minimum, the event time, a reference to the change object, a reference to the underlying subscription triggering the notification, and the action that took place on the object are sent. In addition, the full details of the object may be provided at the discretion of the registry. In the event that the details are not sent, it will be possible to query for the details of the changed object using the reference provided.
451	451
452	452	Content:
	471	+
453	453	EventTime, (ObjectURN | RegistrationID), SubscriptionURN, EventAction, (StructuralEvent | RegistrationEvent)?
454	454
455	455	Element Documentation:
...	...	@@ -467,11 +467,12 @@
467	467
468	468	Derivation:
469	469
470		-* xs:anySimpleType (restriction)
471		-** xs:anyURI (extension)
472		-*** NotificationURLType
	489	+xs:anySimpleType (restriction)
	490	+ [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] xs:anyURI (extension)
	491	+ [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] NotificationURLType
473	473
474	474	Attributes:
	494	+
475	475	isSOAP?
476	476
477	477	Content:
...	...	@@ -484,6 +484,7 @@
484	484	**ValidityPeriodType: **ValidityPeriodType specifies inclusive start and end-dates for the subscription period.
485	485
486	486	Content:
	507	+
487	487	StartDate, EndDate
488	488
489	489	Element Documentation:
...	...	@@ -495,6 +495,7 @@
495	495	**EventSelectorType: **EventSelectorType describes the details of the events for a subscription. It allows subscribers to specify registry and repository events for which they wish to receive notifications.
496	496
497	497	Content:
	519	+
498	498	(StructuralRepositoryEvents | DataRegistrationEvents | MetadataRegistrationEvents)[1..3]
499	499
500	500	Element Documentation:
...	...	@@ -507,9 +507,11 @@
507	507	**StructuralRepositoryEventsType: **StructuralRepositoryEventsType details the structural events for the subscription. At least one maintenance agency must be specified, although it may be given a wildcard value (meaning the subscription is for the structural events of all agencies). This can also be a list of agencies to allow the subscription to subscribe the events of more than one agency. It should be noted that when doing so, all of the subsequent objects are assumed to apply to every agency in the list. The subscription is then refined by detailing the structural objects maintained by the agency for which the subscription should apply. It is possible to explicitly select all object events, all objects of given types, or to individually list out specific objects. Note that for any object, it is also possible to provide an explicit URN to reference a distinct object. In this case, the reference to maintenance agency described above is ignored. Although it is not required, if specific objects are being referenced by explicit URNs, it is good practice to list the agencies.
508	508
509	509	Attributes:
	532	+
510	510	TYPE?
511	511
512	512	Content:
	536	+
513	513	AgencyID+, (AllEvents | (AgencyScheme | DataConsmerScheme | DataProviderScheme | OrganisationUnitScheme | Dataflow | Metadataflow | CategoryScheme | Categorisation | Codelist | HierarchicalCodelist | ConceptScheme | MetadataStructureDefinition | KeyFamily | StructureSet | ReportingTaxonomy | Process | AttachmentConstraint | ContentConstraint | ProvisionAgreement | TransformationScheme | NameAliasScheme | NamePersonalisationScheme | RulesetScheme | UserDefinedOperatorScheme)+)
514	514
515	515	Attribute Documentation:
...	...	@@ -550,6 +550,7 @@
550	550	**IdentifiableObjectEventType: **IdentifiableObjectEventType describes the structure of a reference to an identifiable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.
551	551
552	552	Content:
	577	+
553	553	(All | URN | ID)
554	554
555	555	Element Documentation:
...	...	@@ -562,6 +562,7 @@
562	562	**VersionableObjectEventType: **VersionableObjectEventType describes the structure of a reference to a versionable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.
563	563
564	564	Content:
	590	+
565	565	(All | URN | (ID, Version))
566	566
567	567	Element Documentation:
...	...	@@ -575,9 +575,11 @@
575	575	**DataRegistrationEventsType: **DataRegistrationEventsType details the data registration events for the subscription. It is possible to subscribe to all data registration events in the repository, or specific events for; single registrations, provision agreements, data providers, data flows, key families, and categories that categorize data flows or key families.
576	576
577	577	Attributes:
	604	+
578	578	TYPE?
579	579
580	580	Content:
	608	+
581	581	(AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | DataflowReference | KeyFamilyReference | Category)+)
582	582
583	583	Attribute Documentation:
...	...	@@ -599,9 +599,11 @@
599	599	**MetadataRegistrationEventsType: **MetadataRegistrationEventsType details the metadata registration events for the subscription. It is possible to subscribe to all metadata registration events in the repository, or specific events for; single registrations, provision agreements, data providers, metadata flows, metadata structure definitions, and categories that categorize metadata flows or metadata structure definitions.
600	600
601	601	Attributes:
	630	+
602	602	TYPE?
603	603
604	604	Content:
	634	+
605	605	(AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | MetadataflowReference | MetadataStructureDefinitionReference | Category)+)
606	606
607	607	Attribute Documentation:
...	...	@@ -623,6 +623,7 @@
623	623	**MaintainableEventType: **MaintainableEventType provides a reference to a maintainable object's event with either the URN of the specific object, or a set of potentially wild-carded reference fields.
624	624
625	625	Content:
	656	+
626	626	(URN | Ref)
627	627
628	628	Element Documentation:
...	...	@@ -634,6 +634,7 @@
634	634	**StructuralEventType: **StructuralEventType provides the details of a structure event, specifically the object that changed.
635	635
636	636	Content:
	668	+
637	637	str:Structures
638	638
639	639	Element Documentation:
...	...	@@ -644,6 +644,7 @@
644	644	**RegistrationEventType: **This provides the details of a data or metadata registration event for the purposes of notification.
645	645
646	646	Content:
	679	+
647	647	Registration
648	648
649	649	Element Documentation:
...	...	@@ -651,21 +651,26 @@
651	651	|**Name**|**Type**|**Documentation**
652	652	|Registration|RegistrationType|Registration provides the changed details of the data or metadata registration.
653	653
654		-=== 2.1.3 Simple Types ===
	687	+1.
	688	+11.
	689	+111. Simple Types
655	655
656	656	**IDQueryType: **IDQueryType is a simple type that allows for an identifier to be substituted with a wild card character ("%").
657	657
658	658	Union of:
	694	+
659	659	com:IDType, com:WildCardValueType.
660	660
661	661	**NestedIDQueryType: **NestedIDQueryType is a simple type that allows for a nested identifier to be substituted with a wild card character ("%").
662	662
663	663	Union of:
	700	+
664	664	com:NestedIDType, com:WildCardValueType.
665	665
666	666	**VersionQueryType: **VersionQueryType is a simple type that allows for a version number to be substituted with a wild card character ("%") or a late bound character ("*").
667	667
668	668	Union of:
	706	+
669	669	com:VersionType, com:LateBoundVersionType, com:WildCardValueType.
670	670
671	671	**StatusType: **StatusType provides an enumeration of values that detail the status of queries or requests.
...	...	@@ -688,4 +688,6 @@
688	688	|**Value**|**Documentation**
689	689	|DataSets|Only references data sets should be returned.
690	690	|MetadataSets|Only references to metadata sets should be returned.
691		-|AllSets|References to both data sets and metadata sets should be returned.
	729	+|AllSets|References to both data sets and metadata sets should be returned.
	730	+
	731	+