Skip to content

Commit 434efcf

Browse files
committed
Merge pull request #10 from Rosenheimer/master
Added documents_GET (collection) service and added filename to document_GET JSON schema
2 parents e12e674 + 1f9fed8 commit 434efcf

File tree

2 files changed

+37
-5
lines changed

2 files changed

+37
-5
lines changed

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,9 @@
6868
- [4.8.1 GET Document Reference Services](#481-get-document-reference-services)
6969
- [4.8.2 PUT Document Reference Services](#482-put-document-reference-services)
7070
- [4.9 Document Services](#49-document-services)
71-
- [4.9.1 POST Document Services](#491-post-document-services)
72-
- [4.9.2 GET Document Services](#492-get-document-services)
71+
- [4.9.1 GET Documents Services](#491-get-documents-services)
72+
- [4.9.2 POST Document Services](#492-post-document-services)
73+
- [4.9.3 GET Document Services](#493-get-document-services)
7374

7475

7576
----------
@@ -2009,10 +2010,36 @@ The PUT object may either contain the property "guid" to reference a document st
20092010

20102011
## 4.9 Document Services
20112012

2012-
### 4.9.1 POST Document Services
2013+
### 4.9.1 GET Documents Services
20132014

20142015
[document_GET.json](https://raw.githubusercontent.com/BuildingSMART/BCF-API/master/Schemas_draft-03/Collaboration/Document/document_GET.json)
20152016

2017+
**Recource URL**
2018+
2019+
GET /bcf/{version}/projects/{project_id}/documents
2020+
2021+
Retrieve a **collection** of all documents uploaded to a project.
2022+
2023+
**Example Request**
2024+
2025+
https://example.com/bcf/1.0/projects/F445F4F2-4D02-4B2A-B612-5E456BEF9137/documents
2026+
2027+
**Example Response**
2028+
2029+
[
2030+
{
2031+
"guid":"472ab37a-6122-448e-86fc-86503183b520",
2032+
"filename":"LegalRequirements.pdf"
2033+
},
2034+
{
2035+
"guid":"6cbfe31d-95c3-4f4d-92a6-420c23698721",
2036+
"filename":"DesignParameters.pdf"
2037+
}
2038+
]
2039+
2040+
### 4.9.2 POST Document Services
2041+
2042+
20162043
**Recource URL**
20172044

20182045
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
20262053
**Example Response**
20272054

20282055
{
2029-
"guid":"472ab37a-6122-448e-86fc-86503183b520"
2056+
"guid":"472ab37a-6122-448e-86fc-86503183b520",
2057+
"filename":"Official_Building_Permission.pdf"
20302058
}
20312059

2032-
### 4.9.2 GET Document Services
2060+
### 4.9.3 GET Document Services
20332061

20342062
**Recource URL**
20352063

Schemas_draft-03/Collaboration/Document/document_GET.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
"guid": {
66
"required": true,
77
"type": "string"
8+
},
9+
"filename": {
10+
"required": true,
11+
"type": "string"
812
}
913
}
1014
}

0 commit comments

Comments
 (0)