Difference between revisions of "Property-SpatialUnit"

From OIP Wiki
Jump to: navigation, search
(Added fType for describing file's purpose)
(axe extraInfo)
Line 1: Line 1:
{
+
<pre>
"oip042": {
+
{
"publish": {
+
  "oip042": {
"artifact": {
+
    "publish": {
"floAddress": "string",
+
      "artifact": {
"timestamp": ten digit integer,
+
        "floAddress": "string",
"type": "property",
+
        "timestamp": 1234567890,
"subtype": "spatialUnit",
+
        "type": "property",
"info": {
+
        "subtype": "spatialUnit",
"title": "string",
+
        "info": {
"description": "string",
+
          "title": "string",
"year": 2018,
+
          "description": "string",
"tags": "comma delimited list of search terms",
+
          "year": 2018,
"ns": "string",
+
          "tags": "comma delimited list of search terms"
"geometry": {
+
        },
"type": "string",
+
        "details": {
"data": { "comment":"custom data object based on geometry.type" }
+
          "geometry": {
},
+
            "type": "string",
"spatialType": "string",
+
            "data": {
"spatialUnits": [
+
              "comment": "custom data object based on geometry.type"
"spatialUnit artifact ID",
+
            }
"spatialUnit artifact ID"
+
          },
],
+
          "spatialType": "string",
"attrs": [
+
          "spatialUnits": [
{
+
            "spatialUnit artifact ID",
"key": "key name",
+
            "spatialUnit artifact ID"
"value": "the value"
+
          ],
},
+
          "attrs": [
{
+
            {
"key": "key name",
+
              "key": "key name",
"value": "the value"
+
              "value": "the value"
}
+
            },
],
+
            {
 
+
              "key": "key name",
                                        "extraInfo": {
+
              "value": "the value"
+
            }
}
+
          ],
},
+
          "ns": "string"
"storage": {
+
        },
"network": "string",
+
        "storage": {
"location": "string",
+
          "network": "string",
"files": [
+
          "location": "string",
{
+
          "files": [
"fName": "string",
+
            {
"fSize": 2048,
+
              "fName": "string",
"dName": "string",
+
              "fSize": 2048,
                                                        "fType": "Description of file's purpose, intent, or its context"
+
              "dName": "string",
}
+
              "fType": "Description of file's purpose, intent, or its context"
]
+
            }
},
+
          ]
"signature": "string"
+
        },
}
+
        "signature": "string"
}
+
      }
}
+
    }
}
+
  }
 +
}
 +
</pre>
  
 
  artifact.floAddress ... The FLO txid that published this artifact
 
  artifact.floAddress ... The FLO txid that published this artifact
Line 66: Line 68:
 
  year ... 4 digit integer
 
  year ... 4 digit integer
 
  tags ... Optional comma delimited list of search terms.
 
  tags ... Optional comma delimited list of search terms.
   
+
  artifact.details.              .... artifact.type domain specific details
 
  ns         ... Namespace used for organization and project names.
 
  ns         ... Namespace used for organization and project names.
 
      This will allow a specific property application to
 
      This will allow a specific property application to
Line 82: Line 84:
 
      whose schema is defined by the application. The use of key/value
 
      whose schema is defined by the application. The use of key/value
 
      pairs is one example.
 
      pairs is one example.
 
+
  artifact.storage.
extraInfo              ... Object for additional, unplanned properties. These will not be indexed by OIP.
 
 
 
artifact.storage.
 
 
  network ... Name of the storage network. Typically, IPFS.
 
  network ... Name of the storage network. Typically, IPFS.
 
  location ... IPFS directory location hash
 
  location ... IPFS directory location hash

Revision as of 17:55, 9 April 2018

{
  "oip042": {
    "publish": {
      "artifact": {
        "floAddress": "string",
        "timestamp": 1234567890,
        "type": "property",
        "subtype": "spatialUnit",
        "info": {
          "title": "string",
          "description": "string",
          "year": 2018,
          "tags": "comma delimited list of search terms"
        },
        "details": {
          "geometry": {
            "type": "string",
            "data": {
              "comment": "custom data object based on geometry.type"
            }
          },
          "spatialType": "string",
          "spatialUnits": [
            "spatialUnit artifact ID",
            "spatialUnit artifact ID"
          ],
          "attrs": [
            {
              "key": "key name",
              "value": "the value"
            },
            {
              "key": "key name",
              "value": "the value"
            }
          ],
          "ns": "string"
        },
        "storage": {
          "network": "string",
          "location": "string",
          "files": [
            {
              "fName": "string",
              "fSize": 2048,
              "dName": "string",
              "fType": "Description of file's purpose, intent, or its context"
            }
          ]
        },
        "signature": "string"
      }
    }
  }
}
artifact.floAddress		... The FLO txid that published this artifact
artifact.timestamp		... UNIX timestamp
artifact.type			... Always 'property' for property artifacts
artifact.subType		... 'spatialUnit' for spatialUnit artifacts
artifact.info.
	title			... Name of spatial unit
	description		... Optional descriptive text. This may be
					used for application formatted data. Set
					to empty string if no description is available.
	year			... 4 digit integer
	tags			... Optional comma delimited list of search terms.
artifact.details.              .... artifact.type domain specific details
	ns		        ... Namespace used for organization and project names.
				    This will allow a specific property application to
				    recognize known data structures.
	geometry	        ... Type and data that describes the geometry of this spatial unit
	spatialType	        ... Specific type of spatial unit such as "LegalSpaceUtilityNetwork"
				    and "LegalSpaceBuildingUnit" from LADM. A less formal type
				    would be a "parcel". Look to ns to determine the specific available
				    values for this property.
	spatialUnits	        ... Array of spatial unit artifact ID's
	attrs		        ... An array of JSON objects that represent attributes. Its schema is
				    understand by applications defined by ns, namespace. A simple
				    example would be an array of key/value pairs: [ {"key":"value"), ... ]
				    artifact.storage. To be clear, this property may be a list of objects
				    whose schema is defined by the application. The use of key/value
				    pairs is one example.
 artifact.storage.
	network			... Name of the storage network. Typically, IPFS.
	location		... IPFS directory location hash
	files			... Array of file descriptions. These files provide the sources for this
					artifact. These can be documents, audio, video, or other binary data
					that represent any supporting evidence for this artifact. Additionally,
					the files themselves can contain cryptographic proofs without the
					original content providing a mechanism for privacy where original
					documents are stored off-chain.
		fName		... Filename
		fSize		... File size in bytes
		dName		... Optional display name used by user interfaces
               fType              ...: Description of file's purpose, intent, or its context
artifact.signature		... Signature signed by publisher