From c42ca70f02cb3b5d0dac3451f62600bf3e3438fc Mon Sep 17 00:00:00 2001 From: Georg Dangl Date: Fri, 13 Feb 2015 11:30:34 +0100 Subject: [PATCH 1/2] Added property "filename" to document_GET JSON schema --- Schemas_draft-03/Collaboration/Document/document_GET.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Schemas_draft-03/Collaboration/Document/document_GET.json b/Schemas_draft-03/Collaboration/Document/document_GET.json index 584b7fc..d177579 100644 --- a/Schemas_draft-03/Collaboration/Document/document_GET.json +++ b/Schemas_draft-03/Collaboration/Document/document_GET.json @@ -5,6 +5,10 @@ "guid": { "required": true, "type": "string" + }, + "filename": { + "required": true, + "type": "string" } } } \ No newline at end of file From 1f9fed826b0c38b7ab45aad1d5fe5212c7edf972 Mon Sep 17 00:00:00 2001 From: Georg Dangl Date: Fri, 13 Feb 2015 11:36:12 +0100 Subject: [PATCH 2/2] Added documents_GET (List of documents) service to TOC --- README.md | 38 +++++++++++++++++++++++++++++++++----- 1 file changed, 33 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 244794b..ef78d01 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,9 @@ - [4.8.1 GET Document Reference Services](#481-get-document-reference-services) - [4.8.2 PUT Document Reference Services](#482-put-document-reference-services) - [4.9 Document Services](#49-document-services) - - [4.9.1 POST Document Services](#491-post-document-services) - - [4.9.2 GET Document Services](#492-get-document-services) + - [4.9.1 GET Documents Services](#491-get-documents-services) + - [4.9.2 POST Document Services](#492-post-document-services) + - [4.9.3 GET Document Services](#493-get-document-services) ---------- @@ -2009,10 +2010,36 @@ The PUT object may either contain the property "guid" to reference a document st ## 4.9 Document Services -### 4.9.1 POST Document Services +### 4.9.1 GET Documents Services [document_GET.json](https://raw.githubusercontent.com/BuildingSMART/BCF-API/master/Schemas_draft-03/Collaboration/Document/document_GET.json) +**Recource URL** + + GET /bcf/{version}/projects/{project_id}/documents + +Retrieve a **collection** of all documents uploaded to a project. + +**Example Request** + + https://example.com/bcf/1.0/projects/F445F4F2-4D02-4B2A-B612-5E456BEF9137/documents + +**Example Response** + + [ + { + "guid":"472ab37a-6122-448e-86fc-86503183b520", + "filename":"LegalRequirements.pdf" + }, + { + "guid":"6cbfe31d-95c3-4f4d-92a6-420c23698721", + "filename":"DesignParameters.pdf" + } + ] + +### 4.9.2 POST Document Services + + **Recource URL** POST /bcf/{version}/projects/{project_id}/documents @@ -2026,10 +2053,11 @@ Upload a document (binary file) to a project. The following HTTP headers are use **Example Response** { - "guid":"472ab37a-6122-448e-86fc-86503183b520" + "guid":"472ab37a-6122-448e-86fc-86503183b520", + "filename":"Official_Building_Permission.pdf" } -### 4.9.2 GET Document Services +### 4.9.3 GET Document Services **Recource URL**