|
|
|
|
|
|
|
|
|
BrainML Model: "admin"
|
This is a tabular description of the entities and fields
making up the "admin"
data model. Regular expression notation is used to indicate
quantities -- i.e., '?' following a term means 0 or 1
occurrence, '*' means 0 or more occurrences, '+' means 1 or
more occurrences, and no following character means exactly 1
occurrence.
Fields with names in (parentheses) are attributes in the XML; all
others are subelements with text content. The term "ANY" under
'Contains:' means an element can contain any other element as
content. This description is
also available in XML format.
| This is the schema for the BrainML exchange admin functions. The admin
interface provides for open-ended, application-specific communications. | | Depends on models: (none) | | Index of Entities | |
| container: (none) | contains: ANY | | inherits: (none) | links: (none) |
| | (userID) | token | User ID (account name) of the user account. | | (authKey) | token | Authorization code. This is an opaque value that should be passed back
to the server, together with userID, for subsequent operations. | | (action)? | token | Token specifying requested admin action. | | (opID)? | token | Token specifying identifier to operate on. Leave out if not needed. |
|
| container: (none) | contains: ANY | | inherits: (none) | links: (none) |
| | (status)? | token | Result status. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (code)? | integer | Code is a positive integer code for the type of error.
Codes below 100 are reserved for BrainML use. |
|
BrainML Model: "data_interaction"
|
This is a tabular description of the entities and fields
making up the "data_interaction"
data model. Regular expression notation is used to indicate
quantities -- i.e., '?' following a term means 0 or 1
occurrence, '*' means 0 or more occurrences, '+' means 1 or
more occurrences, and no following character means exactly 1
occurrence.
Fields with names in (parentheses) are attributes in the XML; all
others are subelements with text content. The term "ANY" under
'Contains:' means an element can contain any other element as
content. This description is
also available in XML format.
| This is the BrainML-X protocols subschema describing interactions with
data servers. Included are a means to submit experimental data or other
contents to a data server, and a means to query a data server for data
submissions matching certain criteria. | | Depends on models: (none) | | Index of Entities | |
| container: (none) | contains: ANY | | inherits: submission | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (entity)? | short text | Specifies the entity the field is in (only needed if ambiguous). | | (name) | short text | Specifies the field on which constraints are being laid in a query. | | (value)? | long text | Constraint specifier: field's value must equal this value. | | (valueMin)? | floating point | Constraint specifier: field's value must be greater than or equal to this value. | | (valueMax)? | floating point | Constraint specifier: field's value must be less than or equal to this value. | | (values)? | long text | Constraint specifier: field's value must be one of the values (comma-separated and enclosed in "double quotes" if necessary) given. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (name) | short text | Specifies an entity local name. | | (fields)? | token | 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. | | (contents)? | token | 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. | | (subclasses)? | token | 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.) | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | The full namespace of the model being specified. If this is left
out, the value from the prevailing xml:base attribute is used. |
|
| container: model | contains: (none) | | inherits: (none) | links: (none) |
| | (href) | uri | Reference to linked resource; should be a URL or URN. |
|
| | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | (includeData)? | token | Whether the raw data (not just the metadata) should be included in
the returned XML. Valid values are 'true' and 'false'. If left out,
this attribute defaults to 'true'. | | (statusCodes)? | long text | Specify that only results with these status codes should be returned.
Value should be a comma-separated list of codes, which are server-
dependent. These indicate things like whether a submission has been
approved by a moderator, whether it is currently active, etc..
If this attribute is left out (usually it should be), the server will
return results matching a default status code or set of codes.
Some servers may only heed a statusCode request if the requestor has
authenticated and includes an authorization key in the request with
appropriate permissions. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (type)? | uri | Type of BrainML entity, given as "namespace,name". E.g.,
"urn:bml/brainml.org:internal/Protocols/5,neuroscience_resource". | | (id)? | token | Server-assigned ID for this submission component. |
|
| container: (none) | contains: ANY | | inherits: submission | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| | (code)? | integer | Code is a positive integer code for the type of error.
Codes below 100 are reserved for BrainML use. |
|
| | (status)? | token | Status of the submission. SUCCESS means all components of the submission
were accepted; PARTIAL means that some were, while errors occurred during
the processing of others. FAILED means that no components were accepted. | | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| container: (none) | contains: ANY | | inherits: response | links: (none) |
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
BrainML Model: "catalog_interaction"
|
This is a tabular description of the entities and fields
making up the "catalog_interaction"
data model. Regular expression notation is used to indicate
quantities -- i.e., '?' following a term means 0 or 1
occurrence, '*' means 0 or more occurrences, '+' means 1 or
more occurrences, and no following character means exactly 1
occurrence.
Fields with names in (parentheses) are attributes in the XML; all
others are subelements with text content. The term "ANY" under
'Contains:' means an element can contain any other element as
content. This description is
also available in XML format.
| This is the BrainML-X protocols subschema describing interactions with
catalog servers. Included are a resource description format, a means to
submit resource descriptions to a catalog server, and a means to query
a catalog server for resources matching certain criteria.
- Resource descriptions describe basic information about a resource, such
as URL and technical contact, as well as what the resource contains and
how it is accessed.
- Catalog submissions send one or more resource descriptions to a catalog
server for indexing. Previous authentication is required.
- Catalog queries requests URLs for repositories that serve a certain type
of data. | | Depends on models: BrainMetaL | | Index of Entities | |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| | (id)? | token | This attribute is needed so that others may link to it. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | short_name | token | Short or acronymic name of the resource. | | full_name | token | Full or expanded / descriptive name of the resource. | | url | uri | URL including http:// or other protocol. | | host_resources | long text | If this resource is part of a network or array of related
resources, perhaps hosted by the same organization, this should be
specified here. |
|
| | entry_date? | timestamp | Date / time resource first entered into catalog. | | modification_date? | timestamp | Date / time resource entry most recently modified. | | cataloger? | token | Name or identifier for individual most recently modifying the entry. | | import_source? | uri | | | foreign_id? | token | |
|
| | (id)? | token | This attribute is needed so that others may link to it. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | name | short text | Full name of person. | | email | token | Email address. | | phone? | token | Full phone number including country code for non-U.S. locations. |
|
| | (id)? | token | This attribute is needed so that others may link to it. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | name | short text | Full name of person. | | email | token | Email address. | | phone? | token | Full phone number including country code for non-U.S. locations. |
|
| | resource_type+ | controlled | The type or format of the resource (online data store, reagent supply
house, etc.). Controlled Vocabulary. | | data_format | long text | Description of the available format(s) for the primary contents
provided by the resource (if applicable). | | content_text | long text | Short description and/or key words describing resource's
neuroscience contents, focus, and significance. This is
supplemental or in place of controlled vocabulary selections
below. |
|
| | data_type* | controlled | Keywords describing normal function or disease state relevant to
resource's contents and/or mission. | | neural_structure* | controlled | Keywords describing brain or body location(s) relevant to
resource's contents or mission. | | level_or_component* | controlled | Keywords describing brain or body structural component relevant to
resource's contents and/or mission. | | organism* | controlled | Keywords describing organism(s) relevant to
resource's contents and/or mission. | | technique* | controlled | Keywords describing technique(s) relevant to
resource's contents and/or mission. | | neurobiological_focus* | controlled | Keywords describing functional system relevant to
resource's contents and/or mission. | | stage* | controlled | Keywords describing developmental stage, if any, relevant to
resource's contents and/or mission. | | disease* | controlled | Keywords describing disease condition, if any, relevant to
resource's contents and/or mission. |
|
| | access | controlled | Is this an open resource, is registration required, or is access
restricted to a particular community, or is this a private resource?
Controlled vocabulary. | | license? | controlled | License agreement, if any, restricting (re)use or redistribution of
the data or software tool or other content provided by the resource. | | method+ | controlled | The main interface for obtaining primary data from the resource. | | software_method? | long text | Designated method for software to access data from the resource. | | terminology_type? | controlled | Does this resource use terminology that is shared, open, closed, or
otherwise situated? | | terminology_description? | long text | Description of the terminology used. |
|
| | coverage? | controlled | Estimate of how central this resource is among others providing the
same type of content. | | utility_text | long text | Two-sentence free-text critical evaluation of the utility of this
resource. |
|
| | resource_comments? | long text | Additional comments on the resource. | | interface_comments? | long text | (DEVELOPMENT) Comments on the description structure, controlled
vocabulary, etc. used by the catalog itself. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (type)? | uri | Type of BrainML entity, given as "namespace,name". E.g.,
"urn:bml/brainml.org:internal/Protocols/5,neuroscience_resource". | | (id)? | token | Server-assigned ID for this submission component. |
|
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: and, entity, or | contains: (none) | | inherits: (none) | links: (none) |
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (entity)? | short text | Specifies the entity the field is in (only needed if ambiguous). | | (name) | short text | Specifies the field on which constraints are being laid in a query. | | (value)? | long text | Constraint specifier: field's value must equal this value. | | (valueMin)? | floating point | Constraint specifier: field's value must be greater than or equal to this value. | | (valueMax)? | floating point | Constraint specifier: field's value must be less than or equal to this value. | | (values)? | long text | Constraint specifier: field's value must be one of the values (comma-separated and enclosed in "double quotes" if necessary) given. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (name) | short text | Specifies an entity local name. | | (fields)? | token | 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. | | (contents)? | token | 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. | | (subclasses)? | token | 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.) | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | The full namespace of the model being specified. If this is left
out, the value from the prevailing xml:base attribute is used. |
|
| container: model | contains: (none) | | inherits: (none) | links: (none) |
| | (href) | uri | Reference to linked resource; should be a URL or URN. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| | (code)? | integer | Code is a positive integer code for the type of error.
Codes below 100 are reserved for BrainML use. |
|
| container: (none) | contains: and?, or? | | inherits: query | links: (none) |
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (url)? | uri | URL to repository site root. |
|
| | (id)? | token | This attribute is needed so that others may link to it. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | name | short text | Full name of person. | | email | token | Email address. | | phone? | token | Full phone number including country code for non-U.S. locations. |
|
| | (submissionID)? | token | ID assigned by the server, which may be used to uniquely identify the
submission (on this server). If the value "FAILED" is received,
the submission failed, and 'error' elements under this one specify
the reasons. | | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
BrainML Model: "protocols"
|
This is a tabular description of the entities and fields
making up the "protocols"
data model. Regular expression notation is used to indicate
quantities -- i.e., '?' following a term means 0 or 1
occurrence, '*' means 0 or more occurrences, '+' means 1 or
more occurrences, and no following character means exactly 1
occurrence.
Fields with names in (parentheses) are attributes in the XML; all
others are subelements with text content. The term "ANY" under
'Contains:' means an element can contain any other element as
content. This description is
also available in XML format.
| * This is a convenience schema importing all three protocols subschemas. | | Depends on models: BrainMetaL, Analysis, BrainML, AnimalSubject | | Index of Entities | |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: catalog_submission, catalog_update, protocols_test | contains: link*, cataloging_info?, administrative_contact, technical_contact, characteristics, content, availability, evaluation, comments? | | inherits: entity_element | links: (none) |
| | (id)? | token | This attribute is needed so that others may link to it. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | short_name | token | Short or acronymic name of the resource. | | full_name | token | Full or expanded / descriptive name of the resource. | | url | uri | URL including http:// or other protocol. | | host_resources | long text | If this resource is part of a network or array of related
resources, perhaps hosted by the same organization, this should be
specified here. |
|
| | entry_date? | timestamp | Date / time resource first entered into catalog. | | modification_date? | timestamp | Date / time resource entry most recently modified. | | cataloger? | token | Name or identifier for individual most recently modifying the entry. | | import_source? | uri | | | foreign_id? | token | |
|
| | (id)? | token | This attribute is needed so that others may link to it. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | name | short text | Full name of person. | | email | token | Email address. | | phone? | token | Full phone number including country code for non-U.S. locations. |
|
| | (id)? | token | This attribute is needed so that others may link to it. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | name | short text | Full name of person. | | email | token | Email address. | | phone? | token | Full phone number including country code for non-U.S. locations. |
|
| | resource_type+ | controlled | The type or format of the resource (online data store, reagent supply
house, etc.). Controlled Vocabulary. | | data_format | long text | Description of the available format(s) for the primary contents
provided by the resource (if applicable). | | content_text | long text | Short description and/or key words describing resource's
neuroscience contents, focus, and significance. This is
supplemental or in place of controlled vocabulary selections
below. |
|
| | data_type* | controlled | Keywords describing normal function or disease state relevant to
resource's contents and/or mission. | | neural_structure* | controlled | Keywords describing brain or body location(s) relevant to
resource's contents or mission. | | level_or_component* | controlled | Keywords describing brain or body structural component relevant to
resource's contents and/or mission. | | organism* | controlled | Keywords describing organism(s) relevant to
resource's contents and/or mission. | | technique* | controlled | Keywords describing technique(s) relevant to
resource's contents and/or mission. | | neurobiological_focus* | controlled | Keywords describing functional system relevant to
resource's contents and/or mission. | | stage* | controlled | Keywords describing developmental stage, if any, relevant to
resource's contents and/or mission. | | disease* | controlled | Keywords describing disease condition, if any, relevant to
resource's contents and/or mission. |
|
| | access | controlled | Is this an open resource, is registration required, or is access
restricted to a particular community, or is this a private resource?
Controlled vocabulary. | | license? | controlled | License agreement, if any, restricting (re)use or redistribution of
the data or software tool or other content provided by the resource. | | method+ | controlled | The main interface for obtaining primary data from the resource. | | software_method? | long text | Designated method for software to access data from the resource. | | terminology_type? | controlled | Does this resource use terminology that is shared, open, closed, or
otherwise situated? | | terminology_description? | long text | Description of the terminology used. |
|
| | coverage? | controlled | Estimate of how central this resource is among others providing the
same type of content. | | utility_text | long text | Two-sentence free-text critical evaluation of the utility of this
resource. |
|
| | resource_comments? | long text | Additional comments on the resource. | | interface_comments? | long text | (DEVELOPMENT) Comments on the description structure, controlled
vocabulary, etc. used by the catalog itself. |
|
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (entity)? | short text | Specifies the entity the field is in (only needed if ambiguous). | | (name) | short text | Specifies the field on which constraints are being laid in a query. | | (value)? | long text | Constraint specifier: field's value must equal this value. | | (valueMin)? | floating point | Constraint specifier: field's value must be greater than or equal to this value. | | (valueMax)? | floating point | Constraint specifier: field's value must be less than or equal to this value. | | (values)? | long text | Constraint specifier: field's value must be one of the values (comma-separated and enclosed in "double quotes" if necessary) given. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (name) | short text | Specifies an entity local name. | | (fields)? | token | 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. | | (contents)? | token | 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. | | (subclasses)? | token | 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.) | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | The full namespace of the model being specified. If this is left
out, the value from the prevailing xml:base attribute is used. |
|
| container: model | contains: (none) | | inherits: (none) | links: (none) |
| | (href) | uri | Reference to linked resource; should be a URL or URN. |
|
| | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | (includeData)? | token | Whether the raw data (not just the metadata) should be included in
the returned XML. Valid values are 'true' and 'false'. If left out,
this attribute defaults to 'true'. | | (statusCodes)? | long text | Specify that only results with these status codes should be returned.
Value should be a comma-separated list of codes, which are server-
dependent. These indicate things like whether a submission has been
approved by a moderator, whether it is currently active, etc..
If this attribute is left out (usually it should be), the server will
return results matching a default status code or set of codes.
Some servers may only heed a statusCode request if the requestor has
authenticated and includes an authorization key in the request with
appropriate permissions. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (type)? | uri | Type of BrainML entity, given as "namespace,name". E.g.,
"urn:bml/brainml.org:internal/Protocols/5,neuroscience_resource". | | (id)? | token | Server-assigned ID for this submission component. |
|
| container: (none) | contains: ANY | | inherits: submission | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| | (authKey)? | token | Authorization code. This is an opaque value that should be passed back
to the server, together with userID, for subsequent operations. |
|
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: protocols_test | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (password) | token | Password of the submitter. Plain-text. (Additional security should be
provided by the transport layer, e.g. SSL.) | | (returnUserInfo)? | boolean | If set to true, server will return user contact information if
authentication info is valid. The default is false. |
|
| | (code)? | integer | Code is a positive integer code for the type of error.
Codes below 100 are reserved for BrainML use. |
|
| | (userID) | token | User ID (account name) of the user account. | | (authKey) | token | Authorization code. This is an opaque value that should be passed back
to the server, together with userID, for subsequent operations. | | (action)? | token | Token specifying requested admin action. | | (opID)? | token | Token specifying identifier to operate on. Leave out if not needed. |
|
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: admin*, admin_result*, login*, login_response*, catalog_submission*, catalog_acknowledgement*, catalog_query*, catalog_response*, data_submission*, data_acknowledgement*, data_query*, data_response*, neuroscience_resource*, algorithm_query*, algorithm_response*, analysis_request*, analysis_response* | | inherits: (none) | links: (none) |
|
| | (status)? | token | Result status. |
|
| | (submissionID)? | token | ID assigned by the server, which may be used to uniquely identify the
submission (on this server). If the value "FAILED" is received,
the submission failed, and 'error' elements under this one specify
the reasons. | | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (url)? | uri | URL to repository site root. |
|
| | (status)? | token | Status of the submission. SUCCESS means all components of the submission
were accepted; PARTIAL means that some were, while errors occurred during
the processing of others. FAILED means that no components were accepted. | | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (code)? | integer | Code is a positive integer code for the type of error.
Codes below 100 are reserved for BrainML use. |
|
| | (id)? | token | This attribute is needed so that others may link to it. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | name | short text | Full name of person. | | email | token | Email address. | | phone? | token | Full phone number including country code for non-U.S. locations. |
|
BrainML Model: "analysis_interaction"
|
This is a tabular description of the entities and fields
making up the "analysis_interaction"
data model. Regular expression notation is used to indicate
quantities -- i.e., '?' following a term means 0 or 1
occurrence, '*' means 0 or more occurrences, '+' means 1 or
more occurrences, and no following character means exactly 1
occurrence.
Fields with names in (parentheses) are attributes in the XML; all
others are subelements with text content. The term "ANY" under
'Contains:' means an element can contain any other element as
content. This description is
also available in XML format.
| This is the BrainML-X protocols subschema describing interactions with
analysis servers. Included are a means to request an analysis server
to perform an analysis of spike train data and return the results. | | Depends on models: Analysis, BrainMetaL, BrainML, AnimalSubject | | Index of Entities | |
| container: (none) | contains: ANY | | inherits: submission | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (entity)? | short text | Specifies the entity the field is in (only needed if ambiguous). | | (name) | short text | Specifies the field on which constraints are being laid in a query. | | (value)? | long text | Constraint specifier: field's value must equal this value. | | (valueMin)? | floating point | Constraint specifier: field's value must be greater than or equal to this value. | | (valueMax)? | floating point | Constraint specifier: field's value must be less than or equal to this value. | | (values)? | long text | Constraint specifier: field's value must be one of the values (comma-separated and enclosed in "double quotes" if necessary) given. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (name) | short text | Specifies an entity local name. | | (fields)? | token | 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. | | (contents)? | token | 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. | | (subclasses)? | token | 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.) | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | The full namespace of the model being specified. If this is left
out, the value from the prevailing xml:base attribute is used. |
|
| container: model | contains: (none) | | inherits: (none) | links: (none) |
| | (href) | uri | Reference to linked resource; should be a URL or URN. |
|
| | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | (includeData)? | token | Whether the raw data (not just the metadata) should be included in
the returned XML. Valid values are 'true' and 'false'. If left out,
this attribute defaults to 'true'. | | (statusCodes)? | long text | Specify that only results with these status codes should be returned.
Value should be a comma-separated list of codes, which are server-
dependent. These indicate things like whether a submission has been
approved by a moderator, whether it is currently active, etc..
If this attribute is left out (usually it should be), the server will
return results matching a default status code or set of codes.
Some servers may only heed a statusCode request if the requestor has
authenticated and includes an authorization key in the request with
appropriate permissions. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (type)? | uri | Type of BrainML entity, given as "namespace,name". E.g.,
"urn:bml/brainml.org:internal/Protocols/5,neuroscience_resource". | | (id)? | token | Server-assigned ID for this submission component. |
|
| container: (none) | contains: ANY | | inherits: submission | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (code)? | integer | Code is a positive integer code for the type of error.
Codes below 100 are reserved for BrainML use. |
|
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (status)? | token | Status of the submission. SUCCESS means all components of the submission
were accepted; PARTIAL means that some were, while errors occurred during
the processing of others. FAILED means that no components were accepted. | | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| container: (none) | contains: ANY | | inherits: response | links: (none) |
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
BrainML Model: "login"
|
This is a tabular description of the entities and fields
making up the "login"
data model. Regular expression notation is used to indicate
quantities -- i.e., '?' following a term means 0 or 1
occurrence, '*' means 0 or more occurrences, '+' means 1 or
more occurrences, and no following character means exactly 1
occurrence.
Fields with names in (parentheses) are attributes in the XML; all
others are subelements with text content. The term "ANY" under
'Contains:' means an element can contain any other element as
content. This description is
also available in XML format.
| This is the schema for the BrainML XML login and response format.
All repositories require login for data submission. Some in addition
require it for data access.
The login sends a username and password in plain-text; the response sends
an opaque authorization key that may be used for the duration of a session.
Additional security can be provided by running the login protocol over a
transport layer, such as SSL, that provides for encryption. | | Depends on models: (none) | | Index of Entities | |
| container: (none) | contains: ANY | | inherits: (none) | links: (none) |
| | (authKey)? | token | Authorization code. This is an opaque value that should be passed back
to the server, together with userID, for subsequent operations. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (password) | token | Password of the submitter. Plain-text. (Additional security should be
provided by the transport layer, e.g. SSL.) | | (returnUserInfo)? | boolean | If set to true, server will return user contact information if
authentication info is valid. The default is false. |
|
BrainML Model: "imperatives"
|
This is a tabular description of the entities and fields
making up the "imperatives"
data model. Regular expression notation is used to indicate
quantities -- i.e., '?' following a term means 0 or 1
occurrence, '*' means 0 or more occurrences, '+' means 1 or
more occurrences, and no following character means exactly 1
occurrence.
Fields with names in (parentheses) are attributes in the XML; all
others are subelements with text content. The term "ANY" under
'Contains:' means an element can contain any other element as
content. This description is
also available in XML format.
| 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. | | Depends on models: (none) | | Index of Entities | |
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (type)? | uri | Type of BrainML entity, given as "namespace,name". E.g.,
"urn:bml/brainml.org:internal/Protocols/5,neuroscience_resource". | | (id)? | token | Server-assigned ID for this submission component. |
|
| container: and, entity, or | contains: (none) | | inherits: (none) | links: (none) |
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (entity)? | short text | Specifies the entity the field is in (only needed if ambiguous). | | (name) | short text | Specifies the field on which constraints are being laid in a query. | | (value)? | long text | Constraint specifier: field's value must equal this value. | | (valueMin)? | floating point | Constraint specifier: field's value must be greater than or equal to this value. | | (valueMax)? | floating point | Constraint specifier: field's value must be less than or equal to this value. | | (values)? | long text | Constraint specifier: field's value must be one of the values (comma-separated and enclosed in "double quotes" if necessary) given. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (name) | short text | Specifies an entity local name. | | (fields)? | token | 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. | | (contents)? | token | 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. | | (subclasses)? | token | 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.) | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | The full namespace of the model being specified. If this is left
out, the value from the prevailing xml:base attribute is used. |
|
| container: model | contains: (none) | | inherits: (none) | links: (none) |
| | (href) | uri | Reference to linked resource; should be a URL or URN. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (code)? | integer | Code is a positive integer code for the type of error.
Codes below 100 are reserved for BrainML use. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
BrainML Model: "algorithm_interaction"
|
This is a tabular description of the entities and fields
making up the "algorithm_interaction"
data model. Regular expression notation is used to indicate
quantities -- i.e., '?' following a term means 0 or 1
occurrence, '*' means 0 or more occurrences, '+' means 1 or
more occurrences, and no following character means exactly 1
occurrence.
Fields with names in (parentheses) are attributes in the XML; all
others are subelements with text content. The term "ANY" under
'Contains:' means an element can contain any other element as
content. This description is
also available in XML format.
| This is the BrainML-X protocols subschema describing interactions with
analysis servers. Included are a means to query an analysis server
for algorithms matching certain criteria. | | Depends on models: Analysis, BrainMetaL, BrainML, AnimalSubject | | Index of Entities | |
| container: (none) | contains: ANY | | inherits: submission | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (entity)? | short text | Specifies the entity the field is in (only needed if ambiguous). | | (name) | short text | Specifies the field on which constraints are being laid in a query. | | (value)? | long text | Constraint specifier: field's value must equal this value. | | (valueMin)? | floating point | Constraint specifier: field's value must be greater than or equal to this value. | | (valueMax)? | floating point | Constraint specifier: field's value must be less than or equal to this value. | | (values)? | long text | Constraint specifier: field's value must be one of the values (comma-separated and enclosed in "double quotes" if necessary) given. |
|
| | (namespace)? | uri | Specifies namespace of entity's model. If this is left
out, the value from the prevailing xml:base attribute is used. | | (name) | short text | Specifies an entity local name. | | (fields)? | token | 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. | | (contents)? | token | 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. | | (subclasses)? | token | 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.) | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (namespace)? | uri | The full namespace of the model being specified. If this is left
out, the value from the prevailing xml:base attribute is used. |
|
| container: model | contains: (none) | | inherits: (none) | links: (none) |
| | (href) | uri | Reference to linked resource; should be a URL or URN. |
|
| | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. | | (includeData)? | token | Whether the raw data (not just the metadata) should be included in
the returned XML. Valid values are 'true' and 'false'. If left out,
this attribute defaults to 'true'. | | (statusCodes)? | long text | Specify that only results with these status codes should be returned.
Value should be a comma-separated list of codes, which are server-
dependent. These indicate things like whether a submission has been
approved by a moderator, whether it is currently active, etc..
If this attribute is left out (usually it should be), the server will
return results matching a default status code or set of codes.
Some servers may only heed a statusCode request if the requestor has
authenticated and includes an authorization key in the request with
appropriate permissions. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (type)? | uri | Type of BrainML entity, given as "namespace,name". E.g.,
"urn:bml/brainml.org:internal/Protocols/5,neuroscience_resource". | | (id)? | token | Server-assigned ID for this submission component. |
|
| container: (none) | contains: ANY | | inherits: submission | links: (none) |
| | (userID) | token | User ID (account name) of the submitter. | | (authKey)? | token | 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. | | (identifier)? | token | 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). |
|
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| container: (none) | contains: (none) | | inherits: (none) | links: (none) |
| | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| | (userID)? | token | User ID (account name) of the submitter. Optional for queries, but some
servers may require. | | (authKey)? | token | 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. | | (identifier)? | token | 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. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
| | (code)? | integer | Code is a positive integer code for the type of error.
Codes below 100 are reserved for BrainML use. |
|
| | (status)? | token | Status of the submission. SUCCESS means all components of the submission
were accepted; PARTIAL means that some were, while errors occurred during
the processing of others. FAILED means that no components were accepted. | | (userID) | token | Repeats value given with submission. | | (identifier)? | token | Repeats value given with submission. |
|
| container: (none) | contains: ANY | | inherits: response | links: (none) |
| | (identifier)? | token | Repeats value given with submission. | | (base)? | uri | See http://www.w3.org/TR/xmlbase/ for
information about this attribute. |
|
|
|
|
|
|
|
|
