From fa543e43d3c5a883d74af1021859b7c081596214 Mon Sep 17 00:00:00 2001 From: Ana Bozianu Date: Wed, 7 Dec 2016 15:25:19 +0200 Subject: [PATCH 1/2] RM-4521 - added info about creation of electronic records --- .../src/main/webapp/definitions/ig-core-api.yaml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml b/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml index 120b40c21b..02ea2ca43f 100644 --- a/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml +++ b/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml @@ -200,9 +200,10 @@ paths: Create a fileplan component as a primary child of node **fileplanComponentId**. This API method supports file upload using multipart/form-data. + Electronic records are the only nodes that have content. Use the **filedata** field to represent the content to upload. - You can use a **name** field to give an alternative name for the new file. + You can use a **name** field to give an alternative name for the new electronic record. For multipart/form-data upload you can use the **renditions** field to create renditions (e.g. doclib) asynchronously upon upload. Note that currently only one rendition can be requested. Also, as requesting rendition is a background process, @@ -286,6 +287,14 @@ paths: } ``` + You can create an empty electronic record and use the record endpoint to create content: + ```JSON + { + "name":"My Non-electronic Record", + "nodeType":"cm:content" + } + ``` + You can create a fileplan component inside a container hierarchy: ```JSON { From ad1b9aa6d81842002afeb1581bced78213b0d1d1 Mon Sep 17 00:00:00 2001 From: Ana Bozianu Date: Wed, 7 Dec 2016 15:29:36 +0200 Subject: [PATCH 2/2] RM-4521 - fixed typo --- .../src/main/webapp/definitions/ig-core-api.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml b/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml index 02ea2ca43f..ade891e07b 100644 --- a/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml +++ b/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml @@ -290,7 +290,7 @@ paths: You can create an empty electronic record and use the record endpoint to create content: ```JSON { - "name":"My Non-electronic Record", + "name":"My Electronic Record", "nodeType":"cm:content" } ```