Versions Compared

Key

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

Share Service

...

This service is used for sharing any resources with a user (Bimplus or non-Bimplus user). Resources could be any (eg: attachments, model/slide etc) The recipient will get an email with a link using which the user can download or view the shared resource.

Anchor
shareResource
shareResource

Share a resource(eg: document)

...

Deck of Cards
idbimCreateRevisionbimShareResource
Card
labelURL / Resource / JSON Structure
Resource: revisionsshare

URLhttps://api-stage.bimplus.net/v2/<team_slug>/divisions/<id>/revisionsshare

Examplehttps://api-stage.bimplus.net/v2/bimplus/divisions/00b54edd-c84c-4bd2-a08c-c93d1f28907a/revisionsshare

JSON Structure

will be ignored model

Name

Mandatory / Optional

Type

Description

nameemail

mandatorystring

JSON Array

Name List of the revision

description

optional

string

Short description of the revision

projectId

will be ignored

string (guid)

Creation date of the revision

email address to whom the Bimplus user would like to share

type

mandatory

string(enum)

Type of resource

id

mandatory

divisionId

string (guid)

Id of the

revisionNrwill be ignoredintRevision number
createdwill be ignoredstring (date)Creation date
createdBywill be ignoreduser objectThe user who created it
applicationIdwill be ignoredstring (guid)The id of the application
inputTypeoptionalstringType of upload (eg: "IFC_IMPORT")
Note: The import/upload is always done only for the latest revision.

resource which will be shared

Card
labelHTTP Method
 POST
Card
defaulttrue
labelDescription
 Use this API for creating a new revision. Please, note that import/upload is always done only for the latest revision. i.e if there are no revisions, & if we use import API the always the model is updated/overwritten. If a model has revisions & if we use the import API then always the latest import/upload is linked with the latest revisionThis service is used for sharing any resources with a user (Bimplus or non-Bimplus user). Resources could be any (eg: attachments, model/slide etc) The recipient will get an email with a link using which the user can download or view the shared resource.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
  "emails": [
    "jayaraj.purushothaman@bimplus.net"
  ],
  "type": "Attachment",
  "nameid": "Ballo.ifcb4fac6bb-bb00-4a41-9479-fdd229a6201f"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
    "idemails": "d2d39bca-051e-48fa-ba23-4845087a071c",[
    "name": "Ballo.ifc",jayaraj.purushothaman@bimplus.net"
    "description": ""],
    "projectIdtype": "e31c3480-5633-4506-b717-8dd97c0f0ab3",
    "divisionId": "00b54edd-c84c-4bd2-a08c-c93d1f28907aAttachment",
    "revisionNr": 6,
    "created": "2015-11-03T11:13:27.2",
    "createdby": {
        "id": "71e0ac3bb4fac6bb-fa49bb00-e5404a41-ac2f9479-8caff3dd72edfdd229a6201f",
        "email": "jayaraj.purushothaman@gmail.com"
    },
    "applicationId": "0106c8ba-ad46-7c08-e26f-026852cb7525",
    "inputType": "IFC_IMPORT"
}

...