new response(raw) → {response}
Contructor for a Minerva REST JSON response object.
The constructor argument is an object or a string.
Parameters:
| Name | Type | Description |
|---|---|---|
raw |
Object | String | the JSON object as a string or object |
- Source:
Returns:
response object
- Type
- response
Members
provided_by
Returns whether groups were used (non-null) and what they are (list
of strings).
Alias of groups.
- Source:
Methods
annotations() → {Array}
Returns a list of the (complex) annotations found in the
response. Sometimes not there, so check the return.
- Source:
Returns:
list
- Type
- Array
commentary() → {Object|null}
Returns the commentary object (whatever that might be in any given
case).
- Source:
Returns:
copy of commentary object or null
- Type
- Object | null
data() → {Object|null}
Returns the data object (whatever that might be in any given
case). This grossly returns all response data, if any.
- Source:
Returns:
copy of data object or null
- Type
- Object | null
data_properties() → {Array}
Returns a list of owl data properties, may be used in Monarch, for
things like type restrictions. Empty list if none.
- Source:
Returns:
list
- Type
- Array
evidence() → {Array}
Returns a list of the evidence found in the response. Sometimes not
there, so check the return.
This is a function mostly for meta responses.
- Source:
Returns:
list
- Type
- Array
export_model() → {String}
Returns the string of the export found in the return.
- Source:
Returns:
string
- Type
- String
facts() → {Array}
Returns a list of the facts in the response. Empty list if none.
- Source:
Returns:
list
- Type
- Array
groups() → {Array|null}
Returns whether groups were used (non-null) and what they are (list
of strings).
- Source:
Returns:
group(?) and what they are
- Type
- Array | null
has_redo_p() → {Boolean}
Returns a true or false depending on the existence a redo list.
- Source:
Returns:
boolean
- Type
- Boolean
has_undo_p() → {Boolean}
Returns a true or false depending on the existence an undo list.
- Source:
Returns:
boolean
- Type
- Boolean
inconsistent_p() → {Boolean}
Returns true or false on whether or not the returned model is
thought to be inconsistent. Starting assumption is that it is not.
- Source:
Returns:
true or false
- Type
- Boolean
individuals() → {Array}
Returns a list of the individuals in the response. Empty list if none.
- Source:
Returns:
list
- Type
- Array
inferred_individuals() → {Array}
Returns a list of the inferred_individuals in the response. Empty
list if none.
- Source:
Returns:
list
- Type
- Array
intention() → {String|null}
Returns the user intention for a call.
- Source:
Returns:
string or null
- Type
- String | null
model_id() → {String|null}
Returns the model id of the response.
- Source:
Returns:
string or null
- Type
- String | null
model_ids() → {Array}
Returns a list the model ids found in the response. Sometimes not
there, so check the return.
This is a function mostly for meta responses.
See Also:
- Source:
Returns:
list
- Type
- Array
models_meta() → {Object}
Returns a hash of the model ids to models properties found in the
response.
Sometimes not there, so check the return.
WARNNG: A work in progress, but this is intended as an eventual
replacement to model_ids.
This is a function mostly for meta responses.
See Also:
- Source:
Returns:
model ids to arrays of serialized annotation objects
- Type
- Object
models_meta_read_only() → {Object}
Returns a hash of the model ids to read-only models properties
found in the response.
Sometimes not there, so check the return.
This is a function mostly for meta responses.
See Also: {models_meta}
- Source:
Returns:
hash
- Type
- Object
modified_p() → {Boolean}
Returns true or false on whether or not the returned model is
thought to have been modified since it's last disk save. Starting
assumption is that it has not.
- Source:
Returns:
true or false
- Type
- Boolean
packet_id() → {String|null}
Returns the response's unique id. Usful to make sure you're not
talking to yourself in some cases.
- Source:
Returns:
string or null
- Type
- String | null
properties() → {Array}
Returns a list of relationships (represented like:{ "type":
"property", "id": "BFO:0000050", "label": "part of" }) found in the
model in the response. Empty list if none.
- Source:
Returns:
list
- Type
- Array
reasoner_p() → {Boolean}
Returns whether the reasoner was used or not.
- Source:
Returns:
if none, then false
- Type
- Boolean
redo() → {Array}
Returns the redo list.
- Source:
Returns:
list of redo IDs.
- Type
- Array
relations() → {Array}
Returns a list of the relations found in the response. Sometimes not
there, so check the return.
This is a function mostly for meta responses.
- Source:
Returns:
list
- Type
- Array
shex_violations() → {Array}
Returns an array of objects that describe the ShEx violations
found in a model.
- Source:
Returns:
violations or an empty list if none
- Type
- Array
signal() → {String|null}
Returns the server's action signal, if there was one.
- Source:
Returns:
string or null
- Type
- String | null
undo() → {Array}
Returns the undo list.
- Source:
Returns:
list of undo IDs.
- Type
- Array
user_id() → {String|null}
Returns the user id (uid) for a call if it was generated my a known
user.
- Source:
Returns:
string or null
- Type
- String | null
valid_owl_p() → {Boolean}
Returns boolean on whether the returned model is valid according to
the owl reasoner; true if there is no logic to probe (this is a temporary
measure until reasoner is "always on").
- Source:
Returns:
p - bool
- Type
- Boolean
valid_p() → {Boolean}
Returns boolean on whether the returned model is /completely/
valid; true if there is no logic to probe (this is a temporary
measure until reasoner is "always on").
- Source:
Returns:
p - bool
- Type
- Boolean
valid_shex_p() → {Boolean}
Returns boolean on whether the returned model is valid according to
ShEx shapes in Minerva; true if there is no logic to probe (this is
a temporary measure until reasoner is "always on").
- Source:
Returns:
p - bool
- Type
- Boolean
validation() → {Object|Null}
Returns the validation object. TBD.
- Source:
Returns:
validation - return validation object or null.
- Type
- Object | Null