predicate.listquerysince 0.1
Every predicate of a project, the reserved ones included.
Request
umwelt call story.umw predicate.list '{
"projectId": "ball"
}'Request
const result = await client.predicateList({ projectId: 'ball' });Request
var result = engine.PredicateList(new ProjectId { ProjectIdValue = "ball" });Response
[
{
"id": "arrested",
"label": "was arrested",
"object": "none",
"cardinality": "many"
},
{
"id": "hidden-in",
"label": "hidden in",
"object": "entity",
"cardinality": "one"
},
{ "id": "left", "label": "left", "object": "none", "cardinality": "many" },
{
"id": "stole",
"label": "stole",
"object": "entity",
"cardinality": "many"
},
{
"id": "umwelt:alias",
"label": "Alias",
"object": "value",
"cardinality": "many"
},
{
"id": "umwelt:holds",
"label": "Holds",
"object": "value",
"cardinality": "many"
},
{
"id": "umwelt:member-of",
"label": "Member of",
"object": "entity",
"cardinality": "many"
},
{
"id": "umwelt:name",
"label": "Name",
"object": "value",
"cardinality": "one"
},
{
"id": "umwelt:statement",
"label": "Statement",
"object": "value",
"cardinality": "many"
},
{
"id": "umwelt:title",
"label": "Title",
"object": "value",
"cardinality": "one"
}
]Payload
| Field | Type | Description |
|---|---|---|
projectIdrequired | string | The project to read. |
Result
A list of PredicateDef, each with:
| Field | Type | Description |
|---|---|---|
idalways | string | The predicate’s id. Ids beginning with umwelt: are reserved. |
labelalways | string | How it reads. |
objectalways | "entity" | "value" | "none" | What its object is: an entity, a value, or none. |
cardinalityalways | "one" | "many" | one makes it functional: one value per subject at a time. many allows several. |
subjectTypes | string[] | The entity types its subject may have. Absent: any. |
Errors
VALIDATION_FAILEDThe payload is malformed.NOT_FOUNDThe project does not exist.HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.Every code is listed in Errors.
See also
Was this page helpful?