{\n", " \"_id\": \"625042b202ad3d6126dfe5b5\",\n", " \"_version\": \"1.0.0\",\n", " \"_info\": {\n", " \"_creationInfo\": {\n", " \"_user\": {\n", " \"_username\": \"FAKE\"\n", " },\n", " \"_context\": {\n", " \"_id\": \"/gcube/devsec/devVRE\",\n", " \"_name\": \"/devVRE\"\n", " },\n", " \"_instant\": \"2022-04-08T16:12:01.449\"\n", " },\n", " \"_lastEditInfo\": null,\n", " \"_access\": {\n", " \"_policy\": \"OPEN\",\n", " \"_license\": \"\"\n", " }\n", " },\n", " \"_profileID\": \"basic\",\n", " \"_profileVersion\": \"1.0.0\",\n", " \"_lifecycleInformation\": {\n", " \"_phase\": \"DRAFT\",\n", " \"_lastInvokedStep\": null,\n", " \"_lastOperationStatus\": \"OK\",\n", " \"_errorMessages\": [],\n", " \"_warningMessages\": [],\n", " \"_triggeredEvents\": [\n", " {\n", " \"event\": \"INIT_DOCUMENT\",\n", " \"lastOperationStatus\": \"OK\",\n", " \"errorMessages\": null,\n", " \"warningMessages\": null\n", " }\n", " ],\n", " \"_notes\": null\n", " },\n", " \"_relationships\": null,\n", " \"_spatialReference\": null,\n", " \"_temporalReference\": null,\n", " \"_theDocument\": {\n", " \"myTitle\": \"Some Big Title\"\n", " },\n", " \"_lock\": null\n", "}\n", "\n" ], "text/plain": [ "\u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_id\"\u001b[0m: \u001b[32m\"625042b202ad3d6126dfe5b5\"\u001b[0m,\n", " \u001b[1;34m\"_version\"\u001b[0m: \u001b[32m\"1.0.0\"\u001b[0m,\n", " \u001b[1;34m\"_info\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_creationInfo\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_user\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_username\"\u001b[0m: \u001b[32m\"FAKE\"\u001b[0m\n", " \u001b[1m}\u001b[0m,\n", " \u001b[1;34m\"_context\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_id\"\u001b[0m: \u001b[32m\"/gcube/devsec/devVRE\"\u001b[0m,\n", " \u001b[1;34m\"_name\"\u001b[0m: \u001b[32m\"/devVRE\"\u001b[0m\n", " \u001b[1m}\u001b[0m,\n", " \u001b[1;34m\"_instant\"\u001b[0m: \u001b[32m\"2022-04-08T16:12:01.449\"\u001b[0m\n", " \u001b[1m}\u001b[0m,\n", " \u001b[1;34m\"_lastEditInfo\"\u001b[0m: \u001b[3;35mnull\u001b[0m,\n", " \u001b[1;34m\"_access\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_policy\"\u001b[0m: \u001b[32m\"OPEN\"\u001b[0m,\n", " \u001b[1;34m\"_license\"\u001b[0m: \u001b[32m\"\"\u001b[0m\n", " \u001b[1m}\u001b[0m\n", " \u001b[1m}\u001b[0m,\n", " \u001b[1;34m\"_profileID\"\u001b[0m: \u001b[32m\"basic\"\u001b[0m,\n", " \u001b[1;34m\"_profileVersion\"\u001b[0m: \u001b[32m\"1.0.0\"\u001b[0m,\n", " \u001b[1;34m\"_lifecycleInformation\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_phase\"\u001b[0m: \u001b[32m\"DRAFT\"\u001b[0m,\n", " \u001b[1;34m\"_lastInvokedStep\"\u001b[0m: \u001b[3;35mnull\u001b[0m,\n", " \u001b[1;34m\"_lastOperationStatus\"\u001b[0m: \u001b[32m\"OK\"\u001b[0m,\n", " \u001b[1;34m\"_errorMessages\"\u001b[0m: \u001b[1m[\u001b[0m\u001b[1m]\u001b[0m,\n", " \u001b[1;34m\"_warningMessages\"\u001b[0m: \u001b[1m[\u001b[0m\u001b[1m]\u001b[0m,\n", " \u001b[1;34m\"_triggeredEvents\"\u001b[0m: \u001b[1m[\u001b[0m\n", " \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"event\"\u001b[0m: \u001b[32m\"INIT_DOCUMENT\"\u001b[0m,\n", " \u001b[1;34m\"lastOperationStatus\"\u001b[0m: \u001b[32m\"OK\"\u001b[0m,\n", " \u001b[1;34m\"errorMessages\"\u001b[0m: \u001b[3;35mnull\u001b[0m,\n", " \u001b[1;34m\"warningMessages\"\u001b[0m: \u001b[3;35mnull\u001b[0m\n", " \u001b[1m}\u001b[0m\n", " \u001b[1m]\u001b[0m,\n", " \u001b[1;34m\"_notes\"\u001b[0m: \u001b[3;35mnull\u001b[0m\n", " \u001b[1m}\u001b[0m,\n", " \u001b[1;34m\"_relationships\"\u001b[0m: \u001b[3;35mnull\u001b[0m,\n", " \u001b[1;34m\"_spatialReference\"\u001b[0m: \u001b[3;35mnull\u001b[0m,\n", " \u001b[1;34m\"_temporalReference\"\u001b[0m: \u001b[3;35mnull\u001b[0m,\n", " \u001b[1;34m\"_theDocument\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"myTitle\"\u001b[0m: \u001b[32m\"Some Big Title\"\u001b[0m\n", " \u001b[1m}\u001b[0m,\n", " \u001b[1;34m\"_lock\"\u001b[0m: \u001b[3;35mnull\u001b[0m\n", "\u001b[1m}\u001b[0m\n" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "project= send(method=\"POST\",dest=projects_endpoint,data=json.dumps(doc))\n", "\n", "print(\"Resulting project is \")\n", "print_json(data=project)" ] }, { "cell_type": "markdown", "id": "6c58326a-7f6f-45cf-a963-4fdb19fe42e0", "metadata": { "tags": [] }, "source": [ "## Core Metadata Section\n", "Registered JSON Documents are wrapped in Projects, which Let's inspect the registered JSON object structure and the most useful information in it." ] }, { "cell_type": "markdown", "id": "62cbd63b-0007-428c-82d6-643b6da4577e", "metadata": {}, "source": [ "The field _theDocument represents our document of interest.\n", "\n", "NB : Depending on the linked UCD, the returned document might be different from the output.\\\n", "This is due to the fact that the UCD is configured to automatically perform some operation at creation time (e.g. \"set defaults values\")" ] }, { "cell_type": "code", "execution_count": 4, "id": "2b0076fa-0ab5-44a5-b069-2fdc0d6d70be", "metadata": { "tags": [] }, "outputs": [ { "data": { "text/html": [ "
{\n", " \"myTitle\": \"Some Big Title\"\n", "}\n", "\n" ], "text/plain": [ "\u001b[1m{\u001b[0m\n", " \u001b[1;34m\"myTitle\"\u001b[0m: \u001b[32m\"Some Big Title\"\u001b[0m\n", "\u001b[1m}\u001b[0m\n" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "print_json(data=project[\"_theDocument\"])" ] }, { "cell_type": "markdown", "id": "e2388067-b608-4932-8a9a-573bb07547c4", "metadata": { "tags": [] }, "source": [ "### ID\n", "The field _id is the unique identifier of the project.\\\n", "We are gonna use it for all REST operations that involves our project." ] }, { "cell_type": "code", "execution_count": 5, "id": "8e2fd339-4117-49d4-9a3c-d9463d35ba2d", "metadata": { "tags": [] }, "outputs": [ { "data": { "text/html": [ "
\"625042b202ad3d6126dfe5b5\"\n",
"\n"
],
"text/plain": [
"\u001b[32m\"625042b202ad3d6126dfe5b5\"\u001b[0m\n"
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"print_json(data=project[\"_id\"])"
]
},
{
"cell_type": "markdown",
"id": "d6e89eb2-8eaa-40c3-a058-dd9f44de3d12",
"metadata": {
"tags": []
},
"source": [
"### Accounting Information\n",
"\n",
"The field _info contains the following accounting information related to the project : \n",
"- _creationInfo : user, context and instant of creation\n",
"- _lastEditInfo : user, context and instant of last edit operation\n",
"- _access : project access policy (can be OPEN, RESTRICTED or EMBARGOED), project license"
]
},
{
"cell_type": "code",
"execution_count": 6,
"id": "228daf3a-ec36-403c-84f4-dc7ff1fde026",
"metadata": {
"tags": []
},
"outputs": [
{
"data": {
"text/html": [
"{\n", " \"_creationInfo\": {\n", " \"_user\": {\n", " \"_username\": \"FAKE\"\n", " },\n", " \"_context\": {\n", " \"_id\": \"/gcube/devsec/devVRE\",\n", " \"_name\": \"/devVRE\"\n", " },\n", " \"_instant\": \"2022-04-08T16:12:01.449\"\n", " },\n", " \"_lastEditInfo\": null,\n", " \"_access\": {\n", " \"_policy\": \"OPEN\",\n", " \"_license\": \"\"\n", " }\n", "}\n", "\n" ], "text/plain": [ "\u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_creationInfo\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_user\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_username\"\u001b[0m: \u001b[32m\"FAKE\"\u001b[0m\n", " \u001b[1m}\u001b[0m,\n", " \u001b[1;34m\"_context\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_id\"\u001b[0m: \u001b[32m\"/gcube/devsec/devVRE\"\u001b[0m,\n", " \u001b[1;34m\"_name\"\u001b[0m: \u001b[32m\"/devVRE\"\u001b[0m\n", " \u001b[1m}\u001b[0m,\n", " \u001b[1;34m\"_instant\"\u001b[0m: \u001b[32m\"2022-04-08T16:12:01.449\"\u001b[0m\n", " \u001b[1m}\u001b[0m,\n", " \u001b[1;34m\"_lastEditInfo\"\u001b[0m: \u001b[3;35mnull\u001b[0m,\n", " \u001b[1;34m\"_access\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_policy\"\u001b[0m: \u001b[32m\"OPEN\"\u001b[0m,\n", " \u001b[1;34m\"_license\"\u001b[0m: \u001b[32m\"\"\u001b[0m\n", " \u001b[1m}\u001b[0m\n", "\u001b[1m}\u001b[0m\n" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "print_json(data=project[\"_info\"])" ] }, { "cell_type": "markdown", "id": "5153e2ae-931c-4040-bb15-481a58a6d755", "metadata": { "tags": [] }, "source": [ "### Lifecycle Information \n", "The field _lifecycleInformation contains the a structured report of the status of the project containing: \n", "- _phase : The workflow phase in which the document is at the moment\n", "- _lastInvokedStep : Report on the last executed workflow STEP\n", "- _triggeredEvents : Collections of reports regarding the triggered events\n", "- _notes : User defined notes on the status of the project\n", "- _errorMessages : Human readable error messages, if any\n", "- _warningMessages : Human readable warning messages, if any\n", "\n", "See Plugins section for more information." ] }, { "cell_type": "code", "execution_count": 7, "id": "d2059a6e-b1a5-484a-a48e-16158d6015d5", "metadata": { "tags": [] }, "outputs": [ { "data": { "text/html": [ "
{\n", " \"_phase\": \"DRAFT\",\n", " \"_lastInvokedStep\": null,\n", " \"_lastOperationStatus\": \"OK\",\n", " \"_errorMessages\": [],\n", " \"_warningMessages\": [],\n", " \"_triggeredEvents\": [\n", " {\n", " \"event\": \"INIT_DOCUMENT\",\n", " \"lastOperationStatus\": \"OK\",\n", " \"errorMessages\": null,\n", " \"warningMessages\": null\n", " }\n", " ],\n", " \"_notes\": null\n", "}\n", "\n" ], "text/plain": [ "\u001b[1m{\u001b[0m\n", " \u001b[1;34m\"_phase\"\u001b[0m: \u001b[32m\"DRAFT\"\u001b[0m,\n", " \u001b[1;34m\"_lastInvokedStep\"\u001b[0m: \u001b[3;35mnull\u001b[0m,\n", " \u001b[1;34m\"_lastOperationStatus\"\u001b[0m: \u001b[32m\"OK\"\u001b[0m,\n", " \u001b[1;34m\"_errorMessages\"\u001b[0m: \u001b[1m[\u001b[0m\u001b[1m]\u001b[0m,\n", " \u001b[1;34m\"_warningMessages\"\u001b[0m: \u001b[1m[\u001b[0m\u001b[1m]\u001b[0m,\n", " \u001b[1;34m\"_triggeredEvents\"\u001b[0m: \u001b[1m[\u001b[0m\n", " \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"event\"\u001b[0m: \u001b[32m\"INIT_DOCUMENT\"\u001b[0m,\n", " \u001b[1;34m\"lastOperationStatus\"\u001b[0m: \u001b[32m\"OK\"\u001b[0m,\n", " \u001b[1;34m\"errorMessages\"\u001b[0m: \u001b[3;35mnull\u001b[0m,\n", " \u001b[1;34m\"warningMessages\"\u001b[0m: \u001b[3;35mnull\u001b[0m\n", " \u001b[1m}\u001b[0m\n", " \u001b[1m]\u001b[0m,\n", " \u001b[1;34m\"_notes\"\u001b[0m: \u001b[3;35mnull\u001b[0m\n", "\u001b[1m}\u001b[0m\n" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "print_json(data=project[\"_lifecycleInformation\"])" ] }, { "cell_type": "markdown", "id": "14e0d68a-df8f-434c-9f82-d04bd2ea31d2", "metadata": {}, "source": [ "### Spatial Reference\n", "The field _spatialReference contains a GEOJSON geometry identifying the Project." ] }, { "cell_type": "markdown", "id": "454d5dab-73aa-4fe7-ac44-f42aff1ba679", "metadata": {}, "source": [ "E.g. like the following : \n", "\n", "```json\n", "\"_spatialReference\":\n", " {\n", " \"type\": \"Point\",\n", " \"bbox\":\n", " [\n", " 8.621178639172953,\n", " 40.62975046683799,\n", " 40.630257904721645,\n", " 8.62091913167495\n", " ],\n", " \"coordinates\":\n", " [\n", " -32.00907926554869,\n", " -32.00883133516304\n", " ]\n", " }\n", "```\n" ] }, { "cell_type": "markdown", "id": "a533d6f9-6b3d-429f-acfd-d35c6f1f83c1", "metadata": {}, "source": [ "### Temporal Reference \n", "TBD" ] }, { "cell_type": "markdown", "id": "83850b57-8d2c-47e5-ba48-c213f53493fa", "metadata": { "tags": [] }, "source": [ "## Editing a project\n", "Edit the Document section of a Project. " ] }, { "cell_type": "markdown", "id": "e38ae8ec-6aa9-4932-b052-69f8a6a9132a", "metadata": {}, "source": [ "The Document section is the actual document that needs to be managed, and the most basic operation is updating it.\\\n", "To do this it's sufficient to perform a put operation with our document as the body, specifying our project's ID\n", "\n", "The endpoint for this operation is going to be SERVICE_BASE_ENDPOINT/projects/UCID/ID where:\n", "- SERVICE_BASE_ENDPOINT should be discovered from the infrastructure's Information System\n", "- UCID is the ID of the Use Case Descriptor to be used with this project\n", "- ID is our project Unique Identifier" ] }, { "cell_type": "code", "execution_count": 8, "id": "4323986d-218f-4997-9fe0-c9ba9e3e3c84", "metadata": {}, "outputs": [], "source": [ "#We update our document nesting a sub section in it\n", "doc={\n", " \"myTitle\":\"My newer edited title\",\n", " \"section\":{\"sectionTitle\":\"My new SubSection\"}\n", "}" ] }, { "cell_type": "code", "execution_count": 9, "id": "6123e5e5-9150-47bd-a49a-b2bc21915d34", "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "GOING TO SEND PUT REQUEST TO https://geoportal.dev.int.d4science.net/geoportal-service/srv/projects/basic/625042b202ad3d6126dfe5b5\n", "Data is {\"myTitle\": \"My newer edited title\", \"section\": {\"sectionTitle\": \"My new SubSection\"}}\n", "RESPONSE STATUS 200\n" ] }, { "data": { "text/html": [ "
{\n", " \"myTitle\": \"My newer edited title\",\n", " \"section\": {\n", " \"sectionTitle\": \"My new SubSection\"\n", " }\n", "}\n", "\n" ], "text/plain": [ "\u001b[1m{\u001b[0m\n", " \u001b[1;34m\"myTitle\"\u001b[0m: \u001b[32m\"My newer edited title\"\u001b[0m,\n", " \u001b[1;34m\"section\"\u001b[0m: \u001b[1m{\u001b[0m\n", " \u001b[1;34m\"sectionTitle\"\u001b[0m: \u001b[32m\"My new SubSection\"\u001b[0m\n", " \u001b[1m}\u001b[0m\n", "\u001b[1m}\u001b[0m\n" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "# NB uncomment to actually perform edit\n", "project = send(method=\"PUT\",data=json.dumps(doc),dest=projects_endpoint+\"/\"+str(project[\"_id\"]))\n", "print_json(data=project[\"_theDocument\"])" ] }, { "cell_type": "markdown", "id": "5a3d20fc-dd8a-4d14-ab9b-36d80bad77fc", "metadata": { "tags": [] }, "source": [ "## Upload Attachments : FileSets\n", "Projects' documents can contain multiple collections of files called FileSet." ] }, { "cell_type": "markdown", "id": "11dfedd2-bebd-420e-87b5-06b37bdd9327", "metadata": {}, "source": [ "We use the concept of FileSet to identify a collection of files that should be managed together (e.g. GIS shape file along with its SHX file).\\\n", "In this section we are going to register a FileSet in our project.\\\n", "\n", "The operations triggers :\n", "- the upload and archive of passed data streams\n", "- registration of the file in \"_theDocument\", precisely at the JSON path declared in the request\n", "\n", "NB Please beware that FileSet JSON paths MUST be deined in our UCD schema section." ] }, { "cell_type": "markdown", "id": "e2bdb963-6746-4131-9607-de84b1f8a035", "metadata": {}, "source": [ "In order to perform this operation we are going to create a JSON object request with at least the following information : \n", "- fieldDefinitionPath : a JSON path pointing to the field definition in UCD schema [NB root is \"schema\"]\n", "- parentPath : a JSON path pointing to the parent of our target element [NB root is \"_theDocument\"]\n", "- fieldName : the target element name at which the FileSet is going to be registered\n", "- streams : a collection of JSON objects, each containing\n", " - id : the infrastructure STORAGE volatile ID of our File\n", " - url : [Alternative to ID] the url at which our File can be downloaded.\n", " - filename : our File name" ] }, { "cell_type": "code", "execution_count": 10, "id": "07965581-532d-45e8-bbf8-0bbec1a15273", "metadata": {}, "outputs": [], "source": [ "registerFilesetRequest={\n", " \"fieldDefinitionPath\":\"$.section._children[?(@.fileset)]\",\n", " \"parentPath\":\"$.section\",\n", " \"fieldName\":\"fileset\",\n", " \"streams\":[{\"url\":\"https://www.cnr.it/sites/all/themes/custom/cnr03_theme/img/cnrlogo.svg\",\"filename\":\"myLogo.svg\"}]\n", "}" ] }, { "cell_type": "markdown", "id": "1ee75f2a-1db1-497a-8ec3-cb51fd11a1f1", "metadata": {}, "source": [ "Once our request is ready we can send it to server with a POST request at SERVICE_BASE_ENDPOINT/projects/UCID/registerFiles/ID where:\\\n", "- SERVICE_BASE_ENDPOINT should be discovered from the infrastructure's Information System\n", "- UCID is the ID of the Use Case Descriptor to be used with this project\n", "- ID is our project Unique Identifier" ] }, { "cell_type": "code", "execution_count": 11, "id": "832e043c-870b-4509-be92-d90865cfd105", "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "GOING TO SEND POST REQUEST TO https://geoportal.dev.int.d4science.net/geoportal-service/srv/projects/basic/registerFiles/625042b202ad3d6126dfe5b5\n", "Data is {\"fieldDefinitionPath\": \"$.section._children[?(@.fileset)]\", \"parentPath\": \"$.section\", \"fieldName\": \"fileset\", \"streams\": [{\"url\": \"https://www.cnr.it/sites/all/themes/custom/cnr03_theme/img/cnrlogo.svg\", \"filename\": \"myLogo.svg\"}]}\n", "RESPONSE STATUS 500\n", "CAUSE \n", "
Type Status Report
Message Internal Server Error
Description The server encountered an unexpected condition that prevented it from fulfilling the request.