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 @@ +
  • + SpeckleLine + +
  • +
  • SpecklePolyline @@ -502,6 +507,21 @@
  • +
  • + SpeckleExtrusion + +
  • + +
  • + SpeckleAnnotation + +
  • + +
  • + SpeckleBlock + +
  • + @@ -593,11 +613,7 @@

    UserRegister

    "name": "string", "surname": "string", "company": "string", - "logins": [ - { - "date": "string" - } - ] + "logins": [] }'; const headers = { 'Content-Type':'application/json', @@ -689,11 +705,7 @@

    UserRegister

    "name": "string", "surname": "string", "company": "string", - "logins": [ - { - "date": "string" - } - ] + "logins": [] }

    Parameters

    @@ -723,49 +735,15 @@

    Parameters

    {
       "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": []
     }
     

    Responses

    @@ -848,11 +826,7 @@

    UserLogin

    "name": "string", "surname": "string", "company": "string", - "logins": [ - { - "date": "string" - } - ] + "logins": [] }'; const headers = { 'Content-Type':'application/json', @@ -944,11 +918,7 @@

    UserLogin

    "name": "string", "surname": "string", "company": "string", - "logins": [ - { - "date": "string" - } - ] + "logins": [] }

    Parameters

    @@ -978,49 +948,15 @@

    Parameters

    {
       "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": []
     }
     

    Responses

    @@ -1103,11 +1039,7 @@

    UserSearch

    "name": "string", "surname": "string", "company": "string", - "logins": [ - { - "date": "string" - } - ] + "logins": [] }'; const headers = { 'Content-Type':'application/json', @@ -1199,11 +1131,7 @@

    UserSearch

    "name": "string", "surname": "string", "company": "string", - "logins": [ - { - "date": "string" - } - ] + "logins": [] }

    Parameters

    @@ -1233,49 +1161,15 @@

    Parameters

    {
       "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": []
     }
     

    Responses

    @@ -1430,49 +1324,15 @@

    UserGet

    {
       "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": []
     }
     

    Responses

    @@ -1555,11 +1415,7 @@

    UserUpdateProfile

    "name": "string", "surname": "string", "company": "string", - "logins": [ - { - "date": "string" - } - ] + "logins": [] }'; const headers = { 'Content-Type':'application/json', @@ -1651,11 +1507,7 @@

    UserUpdateProfile

    "name": "string", "surname": "string", "company": "string", - "logins": [ - { - "date": "string" - } - ] + "logins": [] }

    Parameters

    @@ -1686,18 +1538,14 @@

    Parameters

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ] + "resources": [] }
    {
       "success": true,
       "message": "string",
       "resource": {},
    -  "resources": [
    -    {}
    -  ]
    +  "resources": []
     }
     

    Responses

    @@ -1873,49 +1721,15 @@

    Parameters

    {
       "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": []
     }
     

    Responses

    @@ -2072,63 +1886,15 @@

    ClientGetAll

    {
       "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": []
     }
     

    Responses

    @@ -2206,15 +1972,9 @@

    ClientCreate

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "role": "string", "documentGuid": "string", @@ -2309,15 +2069,9 @@

    ClientCreate

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "role": "string", "documentGuid": "string", @@ -2355,63 +2109,15 @@

    Parameters

    {
       "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": []
     }
     

    Responses

    @@ -2489,15 +2195,9 @@

    ClientUpdate

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "role": "string", "documentGuid": "string", @@ -2592,15 +2292,9 @@

    ClientUpdate

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "role": "string", "documentGuid": "string", @@ -2645,63 +2339,15 @@

    Parameters

    {
       "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": []
     }
     

    Responses

    @@ -2877,63 +2523,15 @@

    Parameters

    {
       "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": []
     }
     

    Responses

    @@ -3110,18 +2708,14 @@

    Parameters

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ] + "resources": [] }
    {
       "success": true,
       "message": "string",
       "resource": {},
    -  "resources": [
    -    {}
    -  ]
    +  "resources": []
     }
     

    Responses

    @@ -3278,69 +2872,15 @@

    ProjectGetAll

    {
       "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

    @@ -3418,26 +2958,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": [] }'; const headers = { 'Content-Type':'application/json', @@ -3514,7 +3043,7 @@

    ProjectCreate

    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": [] }

    Parameters

    @@ -7271,18 +5593,14 @@

    Parameters

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ] + "resources": [] }
    {
       "success": true,
       "message": "string",
       "resource": {},
    -  "resources": [
    -    {}
    -  ]
    +  "resources": []
     }
     

    Responses

    @@ -7459,18 +5777,14 @@

    Parameters

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ] + "resources": [] }
    {
       "success": true,
       "message": "string",
       "resource": {},
    -  "resources": [
    -    {}
    -  ]
    +  "resources": []
     }
     

    Responses

    @@ -7653,73 +5967,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

    @@ -7896,186 +6152,16 @@

    Parameters

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ], - "clone": { - "_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" - ] - }, - "parent": { - "_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": [], + "clone": {}, + "parent": {} }
    {
       "success": true,
       "message": "string",
       "resource": {},
    -  "resources": [
    -    {}
    -  ]
    +  "resources": []
     }
     

    Responses

    @@ -8259,100 +6345,16 @@

    Parameters

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ], - "objects": { - "common": [ - "string" - ], - "inA": [ - "string" - ], - "inB": [ - "string" - ] - }, - "layers": { - "common": [ - { - "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 - } - } - ], - "inA": [ - { - "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 - } - } - ], - "inB": [ - { - "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 - } - } - ] - } + "resources": [], + "objects": {}, + "layers": {} }
    {
       "success": true,
       "message": "string",
       "resource": {},
    -  "resources": [
    -    {}
    -  ]
    +  "resources": []
     }
     

    Responses

    @@ -8428,34 +6430,7 @@

    ObjectCreate

    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": [] }

    Parameters

    @@ -8905,73 +6777,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

    @@ -9147,73 +6961,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

    @@ -9390,18 +7146,14 @@

    Parameters

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ] + "resources": [] }
    {
       "success": true,
       "message": "string",
       "resource": {},
    -  "resources": [
    -    {}
    -  ]
    +  "resources": []
     }
     

    Responses

    @@ -9592,9 +7344,7 @@

    Parameters

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ] + "resources": [] }

    Responses

    @@ -9627,19 +7377,20 @@

    ObjectGetBulk

    # 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
    bodybodyarray[string]trueAn 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": []
     }
     

    Responses

    @@ -9794,7 +7558,7 @@

    Responses

    200 OK All good! -ResponseBase +ResponseObject 400 @@ -9816,15 +7580,9 @@

    ResourceBase

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false } @@ -9901,11 +7659,7 @@

    User

    "name": "string", "surname": "string", "company": "string", - "logins": [ - { - "date": "string" - } - ] + "logins": [] }

    Properties

    @@ -9994,15 +7748,9 @@

    AppClient

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "role": "string", "documentGuid": "string", @@ -10107,26 +7855,15 @@

    Project

    "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": [] }

    Properties

    @@ -10179,6 +7916,12 @@

    Properties

    No description +» number +string +false +No description + + » users [string] false @@ -10205,28 +7948,15 @@

    Comment

    "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" } @@ -10331,84 +8061,21 @@

    SpeckleStream

    "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": [] }

    Properties

    @@ -10525,19 +8192,7 @@

    Layer

    "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 - } + "properties": {} }

    Properties

    @@ -10598,10 +8253,7 @@

    Properties

    LayerProperties

    {
    -  "color": {
    -    "a": 1,
    -    "hex": "string"
    -  },
    +  "color": {},
       "visible": true,
       "pointsize": 0,
       "linewidth": 0,
    @@ -10690,9 +8342,7 @@ 

    ResponseBase

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ] + "resources": [] }

    Properties

    @@ -10737,40 +8387,8 @@

    ResponseUser

    {
       "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": {}
     }
     

    Properties

    @@ -10829,54 +8447,8 @@

    ResponseClient

    {
       "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": {}
     }
     

    Properties

    @@ -10935,60 +8507,8 @@

    ResponseProject

    {
       "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": {}
     }
     

    Properties

    @@ -11047,68 +8567,8 @@

    ResponseComment

    {
       "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": {}
     }
     

    Properties

    @@ -11167,176 +8627,8 @@

    ResponseStream

    {
       "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": {}
     }
     

    Properties

    @@ -11395,64 +8687,8 @@

    ResponseObject

    {
       "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": {}
     }
     

    Properties

    @@ -11512,177 +8748,9 @@

    ResponseStreamClone

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ], - "clone": { - "_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" - ] - }, - "parent": { - "_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": [], + "clone": {}, + "parent": {} }

    Properties

    @@ -11742,91 +8810,9 @@

    ResponseStreamDiff

    "success": true, "message": "string", "resource": {}, - "resources": [ - {} - ], - "objects": { - "common": [ - "string" - ], - "inA": [ - "string" - ], - "inB": [ - "string" - ] - }, - "layers": { - "common": [ - { - "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 - } - } - ], - "inA": [ - { - "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 - } - } - ], - "inB": [ - { - "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 - } - } - ] - } + "resources": [], + "objects": {}, + "layers": {} }

    Properties

    @@ -11923,15 +8909,9 @@

    SpeckleObject

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Null", "hash": "hash", @@ -11939,12 +8919,9 @@

    SpeckleObject

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ] + "children": [], + "ancestors": [], + "transform": [] }

    Properties

    @@ -12032,6 +9009,12 @@

    Properties

    false If resulting from a merge, the objects that this one was born out of. + +» transform +[number] +false +No description +

    Enumerated Values

    @@ -12148,15 +9131,9 @@

    SpeckleAbstract

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Abstract", "hash": "hash", @@ -12164,12 +9141,9 @@

    SpeckleAbstract

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "_type": "string", "assembly": "string" } @@ -12238,15 +9212,9 @@

    SpecklePlaceholder

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Abstract", "hash": "hash", @@ -12254,12 +9222,9 @@

    SpecklePlaceholder

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ] + "children": [], + "ancestors": [], + "transform": [] }

    Properties

    @@ -12314,15 +9279,9 @@

    SpeckleBoolean

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Boolean", "hash": "hash", @@ -12330,12 +9289,9 @@

    SpeckleBoolean

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "value": true } @@ -12397,15 +9353,9 @@

    SpeckleNumber

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Number", "hash": "hash", @@ -12413,12 +9363,9 @@

    SpeckleNumber

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "value": 0 } @@ -12480,15 +9427,9 @@

    SpeckleString

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "String", "hash": "hash", @@ -12496,12 +9437,9 @@

    SpeckleString

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "value": "string" } @@ -12563,15 +9501,9 @@

    SpeckleInterval

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Interval", "hash": "hash", @@ -12579,12 +9511,9 @@

    SpeckleInterval

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "start": 0, "end": 0 } @@ -12653,15 +9582,9 @@

    SpeckleInterval2d

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Null", "hash": "hash", @@ -12669,72 +9592,11 @@

    SpeckleInterval2d

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "U": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Interval", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "start": 0, - "end": 0 - }, - "V": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Interval", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "start": 0, - "end": 0 - } + "children": [], + "ancestors": [], + "transform": [], + "U": {}, + "V": {} }

    Properties

    @@ -12795,15 +9657,9 @@

    SpecklePoint

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Point", "hash": "hash", @@ -12811,15 +9667,10 @@

    SpecklePoint

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] + "children": [], + "ancestors": [], + "transform": [], + "value": [] }

    Properties

    @@ -12880,15 +9731,9 @@

    SpeckleVector

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Vector", "hash": "hash", @@ -12896,15 +9741,10 @@

    SpeckleVector

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] + "children": [], + "ancestors": [], + "transform": [], + "value": [] }

    Properties

    @@ -12965,15 +9805,9 @@

    SpecklePlane

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Plane", "hash": "hash", @@ -12981,136 +9815,13 @@

    SpecklePlane

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "Origin": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Point", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Normal": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Xdir": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Ydir": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - } + "children": [], + "ancestors": [], + "transform": [], + "origin": {}, + "normal": {}, + "xdir": {}, + "ydir": {} }

    Properties

    @@ -13157,25 +9868,25 @@

    Properties

    No description -» Origin +» origin SpecklePoint false No description -» Normal +» normal SpeckleVector false No description -» Xdir +» xdir SpeckleVector false No description -» Ydir +» ydir SpeckleVector false No description @@ -13189,15 +9900,9 @@

    SpeckleCircle

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Circle", "hash": "hash", @@ -13205,75 +9910,13 @@

    SpeckleCircle

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "radius": 0, - "center": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Point", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "normal": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - } + "center": {}, + "normal": {}, + "domain": {} }

    Properties

    @@ -13337,6 +9980,12 @@

    Properties

    false No description + +» domain +SpeckleInterval +false +No description +

    SpeckleArc

    @@ -13346,15 +9995,9 @@

    SpeckleArc

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Arc", "hash": "hash", @@ -13362,168 +10005,15 @@

    SpeckleArc

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "radius": 0, "startAngle": 0, "endAngle": 0, "angleRadians": 0, - "plane": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Plane", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "Origin": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Point", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Normal": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Xdir": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Ydir": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - } - } + "plane": {}, + "domain": {} }

    Properties

    @@ -13599,6 +10089,12 @@

    Properties

    false No description + +» domain +SpeckleInterval +false +No description +

    SpeckleEllipse

    @@ -13608,15 +10104,9 @@

    SpeckleEllipse

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Ellipse", "hash": "hash", @@ -13624,166 +10114,13 @@

    SpeckleEllipse

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "firstRadius": 0, "secondRadius": 0, - "plane": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Plane", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "Origin": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Point", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Normal": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Xdir": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Ydir": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - } - } + "plane": {}, + "domain": {} }

    Properties

    @@ -13847,6 +10184,12 @@

    Properties

    false No description + +» domain +SpeckleInterval +false +No description +

    SpecklePolycurve

    @@ -13856,15 +10199,9 @@

    SpecklePolycurve

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Polycurve", "hash": "hash", @@ -13872,42 +10209,11 @@

    SpecklePolycurve

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "segments": [ - { - "_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" - ] - } - ] + "children": [], + "ancestors": [], + "transform": [], + "segments": [], + "domain": {} }

    Properties

    @@ -13959,6 +10265,12 @@

    Properties

    false No description + +» domain +SpeckleInterval +false +No description +

    SpeckleBox

    @@ -13968,15 +10280,9 @@

    SpeckleBox

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Box", "hash": "hash", @@ -13984,254 +10290,13 @@

    SpeckleBox

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "basePlane": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Plane", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "Origin": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Point", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Normal": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Xdir": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - }, - "Ydir": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Vector", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - } - }, - "xSize": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Interval", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "start": 0, - "end": 0 - }, - "ySize": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Interval", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "start": 0, - "end": 0 - }, - "zSize": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Interval", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "start": 0, - "end": 0 - } + "children": [], + "ancestors": [], + "transform": [], + "basePlane": {}, + "xSize": {}, + "ySize": {}, + "zSize": {} }

    Properties

    @@ -14303,6 +10368,87 @@

    Properties

    +

    SpeckleLine

    +

    +
    {
    +  "_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": {}
    +}
    +
    +

    Properties

    +

    allOf - discriminator: SpeckleObject.type

    + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousSpeckleObjectfalseNo description
    +

    and

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousobjectfalseNo description
    » typeanyfalseNo description
    » value[number]falseNo description
    » domainSpeckleIntervalfalseNo description

    SpecklePolyline

    {
    @@ -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": {} }

    Properties

    @@ -14381,11 +10518,23 @@

    Properties

    No description +» closed +boolean +false +No description + + » value [number] false No description + +» domain +SpeckleInterval +false +No description +

    SpeckleCurve

    @@ -14395,15 +10544,9 @@

    SpeckleCurve

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Curve", "hash": "hash", @@ -14411,85 +10554,17 @@

    SpeckleCurve

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "degree": 0, "periodic": 0, "rational": 0, - "points": [ - 0 - ], - "weights": [ - 0 - ], - "knots": [ - 0 - ], - "domain": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Interval", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "start": 0, - "end": 0 - }, - "displayValue": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Polyline", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "value": [ - 0 - ] - } + "points": [], + "weights": [], + "knots": [], + "domain": {}, + "displayValue": {} }

    Properties

    @@ -14592,15 +10667,9 @@

    SpeckleMesh

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Mesh", "hash": "hash", @@ -14608,21 +10677,13 @@

    SpeckleMesh

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "vertices": [ - 0 - ], - "faces": [ - 0 - ], - "colors": [ - 0 - ] + "children": [], + "ancestors": [], + "transform": [], + "vertices": [], + "faces": [], + "colors": [], + "textureCoordinates": [] }

    Properties

    @@ -14686,6 +10747,12 @@

    Properties

    false If any, the colours per vertex. + +» textureCoordinates +[number] +false +The faces array. +

    SpeckleBrep

    @@ -14695,15 +10762,9 @@

    SpeckleBrep

    "owner": "string", "private": true, "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], + "canRead": [], + "canWrite": [], + "comments": [], "deleted": false, "type": "Brep", "hash": "hash", @@ -14711,51 +10772,12 @@

    SpeckleBrep

    "applicationId": "GUID", "properties": {}, "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], + "children": [], + "ancestors": [], + "transform": [], "rawData": {}, "provenance": "string", - "displayValue": { - "_id": "string", - "owner": "string", - "private": true, - "anonymousComments": true, - "canRead": [ - "string" - ], - "canWrite": [ - "string" - ], - "comments": [ - "string" - ], - "deleted": false, - "type": "Mesh", - "hash": "hash", - "geometryHash": "Type.hash", - "applicationId": "GUID", - "properties": {}, - "parent": "string", - "children": [ - "string" - ], - "ancestors": [ - "string" - ], - "vertices": [ - 0 - ], - "faces": [ - 0 - ], - "colors": [ - 0 - ] - } + "displayValue": {} }

    Properties

    @@ -14820,6 +10842,294 @@

    Properties

    No description + +

    SpeckleExtrusion

    +

    +
    {
    +  "_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": {}
    +}
    +
    +

    Properties

    +

    allOf - discriminator: SpeckleObject.type

    + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousSpeckleObjectfalseNo description
    +

    and

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousobjectfalseNo description
    » cappedbooleanfalseNo description
    » profileSpeckleObjectfalseNo description
    » pathStartSpecklePointfalseNo description
    » pathEndSpecklePointfalseNo description
    » pathCurveSpeckleObjectfalseNo description
    +

    SpeckleAnnotation

    +

    +
    {
    +  "_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": {}
    +}
    +
    +

    Properties

    +

    allOf - discriminator: SpeckleObject.type

    + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousSpeckleObjectfalseNo description
    +

    and

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousobjectfalseNo description
    » textstringfalseNo description
    » textHeightnumberfalseNo description
    » fontNamestringfalseNo description
    » boldbooleanfalseNo description
    » italicbooleanfalseNo description
    » locationSpecklePointfalseNo description
    » planeSpecklePlanefalseNo description
    +

    SpeckleBlock

    +

    +
    {
    +  "_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": []
    +}
    +
    +

    Properties

    +

    allOf - discriminator: SpeckleObject.type

    + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousSpeckleObjectfalseNo description
    +

    and

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredDescription
    anonymousobjectfalseNo description
    » namestringfalseNo description
    » descriptionstringfalseNo description
    » objects[SpeckleObject]falseNo description
    diff --git a/package.json b/package.json index 7be3445..1bfa532 100644 --- a/package.json +++ b/package.json @@ -10,6 +10,6 @@ "widdershins": "^3.0.7" }, "scripts": { - "build-shins": "widdershins --maxDepth 1 SpeckleV1OpenApiSpecs.yaml -o SpeckleV1OpenApiSpecs.md && echo 'Building html...' && cd shins && node shins --minify ../SpeckleV1OpenApiSpecs.md && echo 'Done building html. Copying in docs folder now.' && rm ../docs/index.html && cp index.html ../docs && echo 'Done. Ready to push.'" + "build-shins": "widdershins --maxDepth 1 SpeckleV1OpenApiSpecs.yaml -o SpeckleV1OpenApiSpecs.md && echo 'Building html...' && cd shins && node shins ../SpeckleV1OpenApiSpecs.md --minify && echo 'Done building html. Copying in docs folder now.' && rm ../docs/index.html && cp index.html ../docs && echo 'Done. Ready to push.'" } }