diff --git a/docs/index.html b/docs/index.html index ff38131..f27702b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -482,6 +482,11 @@ +
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
POST /projects
ProjectCreate
+Create
Create a project
Body parameter
@@ -3524,26 +3053,15 @@ProjectCreate
"owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "name": "string", - "users": [ - "string" - ], - "streams": [ - "string" - ], - "subProjects": [ - "string" - ] + "number": "string", + "users": [], + "streams": [], + "subProjects": [] }Parameters
@@ -3573,69 +3091,15 @@Parameters
{ "success": true, "message": "string", - "resource": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "name": "string", - "users": [ - "string" - ], - "streams": [ - "string" - ], - "subProjects": [ - "string" - ] - }, - "resources": { - "0": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "name": "string", - "users": [ - "string" - ], - "streams": [ - "string" - ], - "subProjects": [ - "string" - ] - } - } + "resource": {}, + "resources": {} }
{ "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ] + "resources": [] }
Responses
@@ -3673,13 +3137,13 @@ProjectUpdate
Code samples
# You can also use wget
-curl -X PUT http://localhost:3000/api/v1/project/{projectId} \
+curl -X PUT http://localhost:3000/api/v1/projects/{projectId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
-PUT http://localhost:3000/api/v1/project/{projectId} HTTP/1.1
+PUT http://localhost:3000/api/v1/projects/{projectId} HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json
@@ -3695,7 +3159,7 @@ ProjectUpdate
$.ajax({
- url: 'http://localhost:3000/api/v1/project/{projectId}',
+ url: 'http://localhost:3000/api/v1/projects/{projectId}',
method: 'put',
@@ -3713,26 +3177,15 @@ ProjectUpdate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
"name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
+ "number": "string",
+ "users": [],
+ "streams": [],
+ "subProjects": []
}';
const headers = {
'Content-Type':'application/json',
@@ -3742,7 +3195,7 @@ ProjectUpdate
};
-fetch('http://localhost:3000/api/v1/project/{projectId}',
+fetch('http://localhost:3000/api/v1/projects/{projectId}',
{
method: 'PUT',
body: inputBody,
@@ -3766,7 +3219,7 @@ ProjectUpdate
}
-result = RestClient.put 'http://localhost:3000/api/v1/project/{projectId}',
+result = RestClient.put 'http://localhost:3000/api/v1/projects/{projectId}',
params: {
}, headers: headers
@@ -3782,7 +3235,7 @@ ProjectUpdate
}
-r = requests.put('http://localhost:3000/api/v1/project/{projectId}', params={
+r = requests.put('http://localhost:3000/api/v1/projects/{projectId}', params={
}, headers = headers)
@@ -3792,7 +3245,7 @@ ProjectUpdate
-URL obj = new URL("http://localhost:3000/api/v1/project/{projectId}");
+URL obj = new URL("http://localhost:3000/api/v1/projects/{projectId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
@@ -3808,7 +3261,7 @@ ProjectUpdate
-PUT /project/{projectId}
+PUT /projects/{projectId}
ProjectUpdate
Update a project
@@ -3819,26 +3272,15 @@ ProjectUpdate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
"name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
+ "number": "string",
+ "users": [],
+ "streams": [],
+ "subProjects": []
}
Parameters
@@ -3875,69 +3317,15 @@ Parameters
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -3975,12 +3363,12 @@ ProjectGet
Code samples
# You can also use wget
-curl -X GET http://localhost:3000/api/v1/project/{projectId} \
+curl -X GET http://localhost:3000/api/v1/projects/{projectId} \
-H 'Accept: application/json'
-GET http://localhost:3000/api/v1/project/{projectId} HTTP/1.1
+GET http://localhost:3000/api/v1/projects/{projectId} HTTP/1.1
Host: localhost:3000
@@ -3996,7 +3384,7 @@ ProjectGet
$.ajax({
- url: 'http://localhost:3000/api/v1/project/{projectId}',
+ url: 'http://localhost:3000/api/v1/projects/{projectId}',
method: 'get',
@@ -4018,7 +3406,7 @@ ProjectGet
};
-fetch('http://localhost:3000/api/v1/project/{projectId}',
+fetch('http://localhost:3000/api/v1/projects/{projectId}',
{
method: 'GET',
@@ -4042,7 +3430,7 @@ ProjectGet
}
-result = RestClient.get 'http://localhost:3000/api/v1/project/{projectId}',
+result = RestClient.get 'http://localhost:3000/api/v1/projects/{projectId}',
params: {
}, headers: headers
@@ -4057,7 +3445,7 @@ ProjectGet
}
-r = requests.get('http://localhost:3000/api/v1/project/{projectId}', params={
+r = requests.get('http://localhost:3000/api/v1/projects/{projectId}', params={
}, headers = headers)
@@ -4067,7 +3455,7 @@ ProjectGet
-URL obj = new URL("http://localhost:3000/api/v1/project/{projectId}");
+URL obj = new URL("http://localhost:3000/api/v1/projects/{projectId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -4083,7 +3471,7 @@ ProjectGet
-GET /project/{projectId}
+GET /projects/{projectId}
ProjectGet
Get a project
Parameters
@@ -4113,69 +3501,15 @@ Parameters
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -4213,12 +3547,12 @@ ProjectDelete
Code samples
# You can also use wget
-curl -X DELETE http://localhost:3000/api/v1/project/{projectId} \
+curl -X DELETE http://localhost:3000/api/v1/projects/{projectId} \
-H 'Accept: application/json'
-DELETE http://localhost:3000/api/v1/project/{projectId} HTTP/1.1
+DELETE http://localhost:3000/api/v1/projects/{projectId} HTTP/1.1
Host: localhost:3000
@@ -4234,7 +3568,7 @@ ProjectDelete
$.ajax({
- url: 'http://localhost:3000/api/v1/project/{projectId}',
+ url: 'http://localhost:3000/api/v1/projects/{projectId}',
method: 'delete',
@@ -4256,7 +3590,7 @@ ProjectDelete
};
-fetch('http://localhost:3000/api/v1/project/{projectId}',
+fetch('http://localhost:3000/api/v1/projects/{projectId}',
{
method: 'DELETE',
@@ -4280,7 +3614,7 @@ ProjectDelete
}
-result = RestClient.delete 'http://localhost:3000/api/v1/project/{projectId}',
+result = RestClient.delete 'http://localhost:3000/api/v1/projects/{projectId}',
params: {
}, headers: headers
@@ -4295,7 +3629,7 @@ ProjectDelete
}
-r = requests.delete('http://localhost:3000/api/v1/project/{projectId}', params={
+r = requests.delete('http://localhost:3000/api/v1/projects/{projectId}', params={
}, headers = headers)
@@ -4305,7 +3639,7 @@ ProjectDelete
-URL obj = new URL("http://localhost:3000/api/v1/project/{projectId}");
+URL obj = new URL("http://localhost:3000/api/v1/projects/{projectId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
@@ -4321,7 +3655,7 @@ ProjectDelete
-DELETE /project/{projectId}
+DELETE /projects/{projectId}
ProjectDelete
Deletes a project
Parameters
@@ -4352,18 +3686,14 @@ Parameters
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -4443,28 +3773,15 @@ CommentCreate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
+ "resource": {},
"text": "string",
- "assignedTo": [
- "string"
- ],
+ "assignedTo": [],
"closed": true,
- "labels": [
- "string"
- ],
+ "labels": [],
"view": {},
"screenshot": "string"
}';
@@ -4553,28 +3870,15 @@ CommentCreate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
+ "resource": {},
"text": "string",
- "assignedTo": [
- "string"
- ],
+ "assignedTo": [],
"closed": true,
- "labels": [
- "string"
- ],
+ "labels": [],
"view": {},
"screenshot": "string"
}
@@ -4647,77 +3951,15 @@ Enumerated Values
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
- "text": "string",
- "assignedTo": [
- "string"
- ],
- "closed": true,
- "labels": [
- "string"
- ],
- "view": {},
- "screenshot": "string"
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
- "text": "string",
- "assignedTo": [
- "string"
- ],
- "closed": true,
- "labels": [
- "string"
- ],
- "view": {},
- "screenshot": "string"
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -4927,77 +4169,15 @@ Enumerated Values
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
- "text": "string",
- "assignedTo": [
- "string"
- ],
- "closed": true,
- "labels": [
- "string"
- ],
- "view": {},
- "screenshot": "string"
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
- "text": "string",
- "assignedTo": [
- "string"
- ],
- "closed": true,
- "labels": [
- "string"
- ],
- "view": {},
- "screenshot": "string"
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -5173,77 +4353,15 @@ Parameters
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
- "text": "string",
- "assignedTo": [
- "string"
- ],
- "closed": true,
- "labels": [
- "string"
- ],
- "view": {},
- "screenshot": "string"
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
- "text": "string",
- "assignedTo": [
- "string"
- ],
- "closed": true,
- "labels": [
- "string"
- ],
- "view": {},
- "screenshot": "string"
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -5321,28 +4439,15 @@ CommentUpdate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
+ "resource": {},
"text": "string",
- "assignedTo": [
- "string"
- ],
+ "assignedTo": [],
"closed": true,
- "labels": [
- "string"
- ],
+ "labels": [],
"view": {},
"screenshot": "string"
}';
@@ -5431,28 +4536,15 @@ CommentUpdate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
+ "resource": {},
"text": "string",
- "assignedTo": [
- "string"
- ],
+ "assignedTo": [],
"closed": true,
- "labels": [
- "string"
- ],
+ "labels": [],
"view": {},
"screenshot": "string"
}
@@ -5492,18 +4584,14 @@ Parameters
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -5680,18 +4768,14 @@ Parameters
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -5848,185 +4932,15 @@ StreamsGetAll
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "streamId": "string",
- "name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
- "baseProperties": {},
- "globalMeasures": {},
- "isComputedResult": false,
- "viewerLayers": [
- {}
- ],
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "streamId": "string",
- "name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
- "baseProperties": {},
- "globalMeasures": {},
- "isComputedResult": false,
- "viewerLayers": [
- {}
- ],
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -6104,84 +5018,21 @@ StreamCreate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
"streamId": "string",
"name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
+ "objects": [],
+ "layers": [],
"baseProperties": {},
"globalMeasures": {},
"isComputedResult": false,
- "viewerLayers": [
- {}
- ],
+ "viewerLayers": [],
"parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
+ "children": [],
+ "ancestors": []
}';
const headers = {
'Content-Type':'application/json',
@@ -6268,84 +5119,21 @@ StreamCreate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
"streamId": "string",
"name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
+ "objects": [],
+ "layers": [],
"baseProperties": {},
"globalMeasures": {},
"isComputedResult": false,
- "viewerLayers": [
- {}
- ],
+ "viewerLayers": [],
"parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
+ "children": [],
+ "ancestors": []
}
Parameters
@@ -6375,185 +5163,15 @@ Parameters
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "streamId": "string",
- "name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
- "baseProperties": {},
- "globalMeasures": {},
- "isComputedResult": false,
- "viewerLayers": [
- {}
- ],
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "streamId": "string",
- "name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
- "baseProperties": {},
- "globalMeasures": {},
- "isComputedResult": false,
- "viewerLayers": [
- {}
- ],
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -6736,185 +5354,15 @@ Parameters
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "streamId": "string",
- "name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
- "baseProperties": {},
- "globalMeasures": {},
- "isComputedResult": false,
- "viewerLayers": [
- {}
- ],
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "streamId": "string",
- "name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
- "baseProperties": {},
- "globalMeasures": {},
- "isComputedResult": false,
- "viewerLayers": [
- {}
- ],
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -6992,84 +5440,21 @@ StreamUpdate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
"streamId": "string",
"name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
+ "objects": [],
+ "layers": [],
"baseProperties": {},
"globalMeasures": {},
"isComputedResult": false,
- "viewerLayers": [
- {}
- ],
+ "viewerLayers": [],
"parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
+ "children": [],
+ "ancestors": []
}';
const headers = {
'Content-Type':'application/json',
@@ -7156,84 +5541,21 @@ StreamUpdate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
"streamId": "string",
"name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
+ "objects": [],
+ "layers": [],
"baseProperties": {},
"globalMeasures": {},
"isComputedResult": false,
- "viewerLayers": [
- {}
- ],
+ "viewerLayers": [],
"parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
+ "children": [],
+ "ancestors": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
const request = require('node-fetch');
const inputBody = '[
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
+ {}
]';
const headers = {
'Content-Type':'application/json',
@@ -8538,34 +6513,7 @@ ObjectCreate
Body parameter
[
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
+ {}
]
Parameters
@@ -8595,73 +6543,15 @@ Parameters
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
Responses
@@ -8739,15 +6629,9 @@ ObjectUpdate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
"type": "Null",
"hash": "hash",
@@ -8755,12 +6639,9 @@ ObjectUpdate
"applicationId": "GUID",
"properties": {},
"parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
+ "children": [],
+ "ancestors": [],
+ "transform": []
}';
const headers = {
'Content-Type':'application/json',
@@ -8847,15 +6728,9 @@ ObjectUpdate
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
"type": "Null",
"hash": "hash",
@@ -8863,12 +6738,9 @@ ObjectUpdate
"applicationId": "GUID",
"properties": {},
"parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
+ "children": [],
+ "ancestors": [],
+ "transform": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
# You can also use wget
curl -X POST http://localhost:3000/api/v1/objects/getbulk \
+ -H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST http://localhost:3000/api/v1/objects/getbulk HTTP/1.1
Host: localhost:3000
-
-
+Content-Type: application/json
Accept: application/json
-
+
var headers = {
+ 'Content-Type':'application/json',
'Accept':'application/json'
@@ -9660,9 +7411,11 @@ ObjectGetBulk
const request = require('node-fetch');
-
-
+const inputBody = '[
+ "string"
+]';
const headers = {
+ 'Content-Type':'application/json',
'Accept':'application/json'
@@ -9672,8 +7425,7 @@ ObjectGetBulk
fetch('http://localhost:3000/api/v1/objects/getbulk',
{
method: 'POST',
-
-
+ body: inputBody,
headers: headers
})
.then(function(res) {
@@ -9689,6 +7441,7 @@ ObjectGetBulk
headers = {
+ 'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
@@ -9704,6 +7457,7 @@ ObjectGetBulk
import requests
headers = {
+ 'Content-Type': 'application/json',
'Accept': 'application/json'
}
@@ -9737,6 +7491,13 @@ ObjectGetBulk
POST /objects/getbulk
ObjectGetBulk
Gets a load of objects
+
+Body parameter
+
+[
+ "string"
+]
+
Parameters
@@ -9756,6 +7517,13 @@ Parameters
false
Specifiy which fields to retrieve, filters, limits, etc. For example, ?fields=type,properties,hash&type=Circle
+
+body
+body
+array[string]
+true
+An object that holds the keys you want to modify or add.
+
@@ -9765,18 +7533,14 @@ Parameters
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": {}
}
{
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
- "color": {
- "a": 1,
- "hex": "string"
- },
+ "color": {},
"visible": true,
"pointsize": 0,
"linewidth": 0,
@@ -10690,9 +8342,7 @@ ResponseBase
"success": true,
"message": "string",
"resource": {},
- "resources": [
- {}
- ]
+ "resources": []
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "role": "string",
- "avatar": "string",
- "apitoken": "string",
- "token": "string",
- "email": "string",
- "name": "string",
- "surname": "string",
- "company": "string",
- "logins": [
- {
- "date": "string"
- }
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "role": "string",
- "documentGuid": "string",
- "documentName": "string",
- "documentType": "string",
- "documentLocation": "string",
- "streamId": "string",
- "online": true
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "name": "string",
- "users": [
- "string"
- ],
- "streams": [
- "string"
- ],
- "subProjects": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
- "text": "string",
- "assignedTo": [
- "string"
- ],
- "closed": true,
- "labels": [
- "string"
- ],
- "view": {},
- "screenshot": "string"
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "resource": {
- "resourceType": "string",
- "resourceId": "string"
- },
- "text": "string",
- "assignedTo": [
- "string"
- ],
- "closed": true,
- "labels": [
- "string"
- ],
- "view": {},
- "screenshot": "string"
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "streamId": "string",
- "name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
- "baseProperties": {},
- "globalMeasures": {},
- "isComputedResult": false,
- "viewerLayers": [
- {}
- ],
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "streamId": "string",
- "name": "string",
- "objects": [
- {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- ],
- "layers": [
- {
- "name": "string",
- "guid": "string",
- "orderIndex": 0,
- "startIndex": 0,
- "objectCount": 0,
- "topology": "string",
- "properties": {
- "color": {
- "a": 1,
- "hex": "string"
- },
- "visible": true,
- "pointsize": 0,
- "linewidth": 0,
- "shininess": 0,
- "smooth": true,
- "showEdges": true,
- "wireframe": true
- }
- }
- ],
- "baseProperties": {},
- "globalMeasures": {},
- "isComputedResult": false,
- "viewerLayers": [
- {}
- ],
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
"success": true,
"message": "string",
- "resource": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- },
- "resources": {
- "0": {
- "_id": "string",
- "owner": "string",
- "private": true,
- "anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
- "deleted": false,
- "type": "Null",
- "hash": "hash",
- "geometryHash": "Type.hash",
- "applicationId": "GUID",
- "properties": {},
- "parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ]
- }
- }
+ "resource": {},
+ "resources": {}
}
{
+ "_id": "string",
+ "owner": "string",
+ "private": true,
+ "anonymousComments": true,
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
+ "deleted": false,
+ "type": "Line",
+ "hash": "hash",
+ "geometryHash": "Type.hash",
+ "applicationId": "GUID",
+ "properties": {},
+ "parent": "string",
+ "children": [],
+ "ancestors": [],
+ "transform": [],
+ "value": [],
+ "domain": {}
+}
+
+allOf - discriminator: SpeckleObject.type
+Name | +Type | +Required | +Description | +
---|---|---|---|
anonymous | +SpeckleObject | +false | +No description | +
and
+Name | +Type | +Required | +Description | +
---|---|---|---|
anonymous | +object | +false | +No description | +
» type | +any | +false | +No description | +
» value | +[number] | +false | +No description | +
» domain | +SpeckleInterval | +false | +No description | +
{
@@ -14310,15 +10456,9 @@ SpecklePolyline
"owner": "string",
"private": true,
"anonymousComments": true,
- "canRead": [
- "string"
- ],
- "canWrite": [
- "string"
- ],
- "comments": [
- "string"
- ],
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
"deleted": false,
"type": "Polyline",
"hash": "hash",
@@ -14326,15 +10466,12 @@ SpecklePolyline
"applicationId": "GUID",
"properties": {},
"parent": "string",
- "children": [
- "string"
- ],
- "ancestors": [
- "string"
- ],
- "value": [
- 0
- ]
+ "children": [],
+ "ancestors": [],
+ "transform": [],
+ "closed": true,
+ "value": [],
+ "domain": {}
}
{
+ "_id": "string",
+ "owner": "string",
+ "private": true,
+ "anonymousComments": true,
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
+ "deleted": false,
+ "type": "Null",
+ "hash": "hash",
+ "geometryHash": "Type.hash",
+ "applicationId": "GUID",
+ "properties": {},
+ "parent": "string",
+ "children": [],
+ "ancestors": [],
+ "transform": [],
+ "capped": true,
+ "profile": {},
+ "pathStart": {},
+ "pathEnd": {},
+ "pathCurve": {}
+}
+
+allOf - discriminator: SpeckleObject.type
+Name | +Type | +Required | +Description | +
---|---|---|---|
anonymous | +SpeckleObject | +false | +No description | +
and
+Name | +Type | +Required | +Description | +
---|---|---|---|
anonymous | +object | +false | +No description | +
» capped | +boolean | +false | +No description | +
» profile | +SpeckleObject | +false | +No description | +
» pathStart | +SpecklePoint | +false | +No description | +
» pathEnd | +SpecklePoint | +false | +No description | +
» pathCurve | +SpeckleObject | +false | +No description | +
{
+ "_id": "string",
+ "owner": "string",
+ "private": true,
+ "anonymousComments": true,
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
+ "deleted": false,
+ "type": "Null",
+ "hash": "hash",
+ "geometryHash": "Type.hash",
+ "applicationId": "GUID",
+ "properties": {},
+ "parent": "string",
+ "children": [],
+ "ancestors": [],
+ "transform": [],
+ "text": "string",
+ "textHeight": 0,
+ "fontName": "string",
+ "bold": true,
+ "italic": true,
+ "location": {},
+ "plane": {}
+}
+
+allOf - discriminator: SpeckleObject.type
+Name | +Type | +Required | +Description | +
---|---|---|---|
anonymous | +SpeckleObject | +false | +No description | +
and
+Name | +Type | +Required | +Description | +
---|---|---|---|
anonymous | +object | +false | +No description | +
» text | +string | +false | +No description | +
» textHeight | +number | +false | +No description | +
» fontName | +string | +false | +No description | +
» bold | +boolean | +false | +No description | +
» italic | +boolean | +false | +No description | +
» location | +SpecklePoint | +false | +No description | +
» plane | +SpecklePlane | +false | +No description | +
{
+ "_id": "string",
+ "owner": "string",
+ "private": true,
+ "anonymousComments": true,
+ "canRead": [],
+ "canWrite": [],
+ "comments": [],
+ "deleted": false,
+ "type": "Null",
+ "hash": "hash",
+ "geometryHash": "Type.hash",
+ "applicationId": "GUID",
+ "properties": {},
+ "parent": "string",
+ "children": [],
+ "ancestors": [],
+ "transform": [],
+ "name": "string",
+ "description": "string",
+ "objects": []
+}
+
+allOf - discriminator: SpeckleObject.type
+Name | +Type | +Required | +Description | +
---|---|---|---|
anonymous | +SpeckleObject | +false | +No description | +
and
+Name | +Type | +Required | +Description | +
---|---|---|---|
anonymous | +object | +false | +No description | +
» name | +string | +false | +No description | +
» description | +string | +false | +No description | +
» objects | +[SpeckleObject] | +false | +No description | +