This is the BrainML-X protocols subschema describing generic imperatives
for query, response, submission, and acknowledgement. These are never used
directly, but are extended from for catalog and data interactions.
Common superclass for different types of BrainML-X queries.
Do not use directly.
User ID (account name) of the submitter. Optional for queries, but some
servers may require.
Authorization code. BrainML-X does not currently define authentication
methods, but assumes that SSL or similar will be used. Depending on the
method, it may or may not be necessary to include an authentication
marker, digital signature, or hash / MD5 value with the content itself.
Optional for queries, but some servers may require.
This is an arbitrary identifier supplied by the client that it can use
to match up the server's response with the submission (if multiple
submissions are being sent in a single session). Optional.
Specify schema namespace starting point for contained references.
Common superclass for different types of BrainML-X query responses.
Do not use directly.
Repeats value given with submission.
Specify schema namespace starting point for contained references.
Common superclass for different types of BrainML-X submissions.
Do not use directly.
User ID (account name) of the submitter.
Authorization code. BrainML-X defines but does not mandate an
authentication method Depending on the method, it may or may not
be necessary to include an authentication marker, digital signature,
or hash / MD5 value with the content itself.
This is an arbitrary identifier supplied by the client that it can use
to match up the server's response with the submission (if multiple
submissions are being sent in a single session).
Common superclass for different types of BrainML-X submission
acknowledgements. Do not use directly.
Repeats value given with submission.
Repeats value given with submission.
Generic error element, returned as sole element for any type of query
generating an error. Includes a numeric error code. The contents of
the element include a description of the type as well as any particular
information about what went wrong.
Code is a positive integer code for the type of error.
Codes below 100 are reserved for BrainML use.
Compositor for use in catalog and data queries.
Compositor for use in catalog and data queries.
Compositor for use in catalog and data queries.
Used in catalog_query (to specify a model whose presence is being
queried for) and bml_resource (to list a supported model).
The model is specified by its namespace.
The full namespace of the model being specified. If this is left
out, the value from the prevailing xml:base attribute is used.
Type for specifying a controlled vocabulary term in a model.
Type for specifying catalog query conditions and data query return content.
The default for each of 'fields', 'contents', and 'subclasses' is "all".
Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used.
Specifies an entity local name.
Specifies which fields are to be returned for the entity. If absent,
all fields are returned. If present, should have the value "specified",
indicating fields specified by child elements should be returned.
Specifies which child entities of the given entity should be returned.
If absent, all possible child elements will be returned. If present,
should have the value "specified", indicating only entities specified by
child elements should be returned.
Specifies which subclass entities of the given entity should be
returned. If absent, all subclasses are returned. If present, should
have the value "none", meaning no subclass entities returned. (It is
not possible to specify individual subclasses at this time.)
Specify schema namespace starting point for contained references.
Specifies a field constraint in a catalog or data query.
Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used.
Specifies the entity the field is in (only needed if ambiguous).
Specifies the field on which constraints are being laid in a query.
Constraint specifier: field's value must equal this value.
Constraint specifier: field's value must be greater than or equal to this value.
Constraint specifier: field's value must be less than or equal to this value.
Constraint specifier: field's value must be one of the values (comma-separated and enclosed in "double quotes" if necessary) given.
Element used to identify and report the server-assigned ID for a component
of a submission. One element will be given for each component submitted.
Type of BrainML entity, given as "namespace,name". E.g.,
"urn:bml/brainml.org:internal/Protocols/5,neuroscience_resource".
Server-assigned ID for this submission component.