Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

Anchor
projectService
projectService

...

Deck of Cards
idbimDeleteProject
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

Card
labelHTTP Method
 DELETE
Card
labelDescription
 Deletes a specified project.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Anchor
FilteringAndPaging
FilteringAndPaging
Filtering and paging

Those project requests that returns a list of resources also supports filtering and paging of the results.

...

  • get list of projects
  • get project attachments
  • get project issues ( only paging, not filtering )


Paging

Using following query parameters :

  • page - requested number of page
  • pageSize - size of page
  • sortColumn - name of the column ( property ) by which the list is sorted
  • sortDirection - asceding or descending

...

 GET https://api-stage.bimplus.net/v2/<team_slug>/projects?sortColumn=name&sortDirection=ascending


Filtering : 

Using a filter added as a query parameter. Filter has following format : ?filter=<property><operator><value>

...

Supported operators are : "=", "!=", "<", ">", ">=", "<=" and "*"

 

It is also possible to combine expressions in filter using AND operator : ?filter=<property1><operator1><value1>%26<property2><operator2><value2>%26,,,

...

 GET https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments?filter=creator.email=myuser@allplan.com%26createdAt>2016-07-27T07:00:00 - get attachments created by the given user since the time

 https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments