{"componentChunkName":"component---src-templates-default-template-tsx","path":"/documentation/api/list-api/","result":{"data":{"asciidoc":{"id":"48f9581b-5ff8-5334-97d3-398ab0e499da","html":"
\n

HIRO Graph List API

\n
\n
\n

The list API allows one to maintain multiple values for one property.\nA property normally looks like:

\n
\n
\n
\n
{ \"ogit/name\": \"HIRO\" }
\n
\n
\n
\n

A listified property looks like

\n
\n
\n
\n
{\"ogit/name\": [{\"value\": \"foo\"}, {\"value\": \"bar\", \"created\": 1523360364631}]}
\n
\n
\n
\n

whereas the inner structure is actually stored as stringified JSON:

\n
\n
\n
\n
{\"ogit/name\": [{\"value\":\"foo\"}, {\"value\":\"bar\", \"created\":1523360364631}]}
\n
\n
\n
\n

In order to work with list values, the normal API calls can be used, with prefixed field names.\nIn order to read listified values as list, parameter listMeta should be used.

\n
\n
\n

Once a value is converted to list it stays as list, but it is still allows to manipulate the list values\nas a normal value. In that case a list is replaced with a new one element list (see examples).

\n
\n
\n

EXAMPLE of reading:

\n
\n
\n
\n
GET https://{url}/{id}?listMeta=true
\n
\n
\n
\n

If created key was not set, it will be added automatically set to now in milliseconds.

\n
\n
\n

Setting the contents of a list

\n
\n

By using = as the first key to a property name, one will set the values of the list removing all others.

\n
\n
\n

BEFORE:

\n
\n
\n
\n
  {\n    \"ogit/name\": \"hello\"\n  }
\n
\n
\n
\n

UPDATE json:

\n
\n
\n
\n
  {\n    \"=ogit/name\": [{\"value\": \"foo\"}, {\"value\": \"bar\"}]\n  }
\n
\n
\n
\n

AFTER with listMeta:

\n
\n
\n
\n
  {\n    \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n  }
\n
\n
\n
\n

AFTER without listMeta:

\n
\n
\n
\n
  {\n    \"ogit/name\": \"[\\\"foo\\\", \\\"bar\\\"]\"\n  }
\n
\n
\n
\n

Update in backwards-compatible mode

\n
\n
\n

BEFORE:

\n
\n
\n
\n
  {\n    \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364000}]\n  }
\n
\n
\n
\n

UPDATE json:

\n
\n
\n
\n
  {\n    \"ogit/name\": \"bar\"\n  }
\n
\n
\n
\n

AFTER with listMeta:

\n
\n
\n
\n
  {\n    \"ogit/name\": [{\"value\": \"bar\", \"created\": 1523360364635}]\n  }
\n
\n
\n
\n

AFTER without listMeta:

\n
\n
\n
\n
  {\n    // one element list is represented as scalar element\n    \"ogit/name\": \"bar\"\n  }
\n
\n
\n
\n

Update, which doesn’t change meta of values:

\n
\n
\n

BEFORE:

\n
\n
\n
\n
  {\n    \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364000}]\n  }
\n
\n
\n
\n

UPDATE json:

\n
\n
\n
\n
  {\n    // If 'created' field is not specified by update, and value exists in a list,\n    // it will not get new `created` timestamp\n    \"=ogit/name\": [{\"value\": \"foo\"}]\n    // OR\n    \"ogit/name\": \"foo\"\n  }
\n
\n
\n
\n

AFTER with listMeta:

\n
\n
\n
\n
  {\n    \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364000}\n  }
\n
\n
\n
\n

AFTER without listMeta:

\n
\n
\n
\n
  {\n    // one element list is represented as scalar element\n    \"ogit/name\": \"foo\"\n  }
\n
\n
\n
\n
\n

Adding to the contents of a list

\n
\n

By using + as the first key to a property name, one can add one or more values.

\n
\n
\n

BEFORE:

\n
\n
\n
\n
  {\n    \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n  }
\n
\n
\n
\n

UPDATE json:

\n
\n
\n
\n
  {\n    \"+ogit/name\": [{\"value\": \"foobar\"}]\n  }
\n
\n
\n
\n

AFTER with listMeta:

\n
\n
\n
\n
  {\n    \"ogit/name\": [\n        {\"value\": \"foo\", \"created\": 1523360364631},\n        {\"value\": \"bar\", \"created\": 1523360364631},\n        {\"value\": \"foobar\", \"created\": 1523360364633}\n     ]\n  }
\n
\n
\n
\n

AFTER without listMeta (order has no garanties):

\n
\n
\n
\n
  {\n    \"ogit/name\": \"[\\\"foobar\\\", \\\"foo\\\", \\\"bar\\\"]\"\n  }
\n
\n
\n
\n
\n

Removing from the contents of a list

\n
\n

By using - as the first key to a property name, one can remove one or more values.\nSpecifying properties in the removal call will only remove those items in the list, that match all properties specified by the item to remove.

\n
\n
\n

BEFORE:

\n
\n
\n
\n
  {\n    \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n  }
\n
\n
\n
\n

UPDATE json:

\n
\n
\n
\n
  {\n    \"-ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 0}]\n  }
\n
\n
\n
\n

AFTER with listMeta:

\n
\n
\n
\n
  {\n    \"ogit/name\": [{\"value\": \"bar\", \"created\": 1523360364631}]\n  }
\n
\n
\n
\n
\n

Converting to list

\n
\n

One can create a list by calling any of = on a scalar property value:

\n
\n
\n

BEFORE:

\n
\n
\n
\n
  {\n    \"ogit/name\": \"foo\"\n  }
\n
\n
\n
\n

UPDATE json:

\n
\n
\n
\n
  {\n    \"=ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n  }
\n
\n
\n
\n

AFTER:

\n
\n
\n
\n
  {\n    \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n  }
\n
\n
\n
\n

Removing existing scalar property with list API, if value has no created timestamp (not in a list form),\nvertex ogit/_created-on should be used instead:

\n
\n
\n

BEFORE:

\n
\n
\n
\n
  {\n    \"ogit/name\": \"foo\",\n    \"ogit/_created-on\": \"15233603640000\"\n  }
\n
\n
\n
\n

UPDATE json:

\n
\n
\n
\n
  {\n    \"-ogit/name\": [{\"value\": \"foo\", \"created\": 15233603640000}]\n  }
\n
\n
\n
\n

AFTER:

\n
\n
\n
\n
  {\n  }
\n
\n
\n
\n
\n
","document":{"main":"HIRO Graph List API","title":"HIRO Graph List API","subtitle":""},"fields":{"toc":false,"location":["documentation","api","list-api"]}},"sidebarYaml":{"id":"6d066bdd-c982-5a69-b909-a31e6fc044e0","showIndex":null}},"pageContext":{"id":"48f9581b-5ff8-5334-97d3-398ab0e499da","parent":"documentation"}},"staticQueryHashes":["1010459453","1010459453","2356112386","2356112386","2603905930","2603905930","3026652197","3026652197","3167850324","3167850324","63159454","63159454"]}