/oauth

post

OAuth 2-legged authentication

get

Redirect to acquire end user consent

post

Exchange authorization code for a 3-legged access token

post

Get a new access token using an existing refresh token

/administration

post

Create a new user

get

Get informations about user described by provided email

get

Get companies that authenticated client has access to

get

Get projects that authenticated client has access to

post

Create a new company

put

Update the specified company

put

Update specified project's state

/user

Get informations about the logged in user.

The user's companies.

get

The user's company as specified.

get

Return user's company where company id = {id}

The user's informations.

get
get

Return user's license.

/export

get

Start exporting specified project as a zip file

/actor

Get informations about an actor, a user linked to a company.

Details about the actor. See the examples for more explaination.

get

Return the actor's details.

The actor's projects.

get

Return all the projects of the actor (when he have access) in his company.

get

Return a specific project information

get

Get all the projects and projects group of the current actor.

get

Get all the projects in a project group.

/projects

Get informations about the projects linked to the logged in actor.

The files of the project, where project id = {id}

get

Return an array describing the files and the path to find them.

get

Get files to certify

get

Get the number of documents at each step of the visa wf (A faire, Fait, En retard).

The actors of the project

get

Return an array describing the actors.

The groups of the project

get

Return an array describing the groups.

The missions of the project

get

Return an array describing the missions.

The tree structure of the project

get

Return an array describing the project tree structure.

The bim configuration of the project

get

Return an array describing the project bim configuration.

The files of the project, inside {root_id}

get

Return an array describing the files.

The files of the project, inside {root_id}, changed since a given date

get

Return an array describing the changed files.

The folders of the project, inside {root_id}

get

Return an array describing the folders.

get

Get information on a specific object

get

Get paths of 3D model source files for offline Forge Viewer use

post

Get information on a specific object

/files

get

Return specified file

put

Update a file.

delete

Deletes a file.

post

Lock specified file.

post

Unlock specified file.

post

Upload a file.

/folders

post

Creates a folder

delete

Deletes a folder.

/workflows

Workflow related requests.

get

Get informations on the visa workflow.

get

Get informations on each workflow step.

post

Apply a visa on file's workflow.

get

Return a list of people that can certify the document.

get

Return the actions a user can apply on the visa worflow.

get

Return all informations about current workflow state of given document

post

Returns true if given visa is valid depending on mission, state and workflow.

/pdc

get

Get the values on which the user can filter his files.

/tools

Gather the useful function to perform on the platform.

Allow to perform a research on the users, tasks, projects, folders and files.

get

Return the objects corresponding to the {query}.

/datas

Informations about modules

get

Returns which modules are active for given project

post

Returns logged actor module rights for given project

post

Returns all actors module rights for given project

/bcf

Informations on the BCF, a format to help to collaborate and exchange comments on a 3D-construction.

The BCF versions used.

get

Return a list of all supported BCF API versions.

The platform support the 2.1-version BCF.

Information on a workplace's BIM objects

get

Return all the model objects in the workspace.

Informations on a BIM object's projects.

get

Returns a collection of ObjProjects

Informations on the projects.

get

Returns a collection of Projects

post

Requests the creation of a new Project

Informations on a project.

get

Returns Project data

put

Updates Project data

get

Returns Extension data

get

Exports a project as BCFZIP.

Informations on a project's topics.

get

Returns a collection of Topics

post

Requests the creation of a new Topic

Information on a project's topic.

get

Returns Topic data

put

Updates Topic data

Information on the comments made inside a project's topic.

get

Returns a collection of Comments

post

Requests the creation of a new Comment

Information on a topic's comment.

get

Returns Comment data

Information on the viewpoints made inside a project's topic.

get

Returns a collection of Viewpoints

post

Requests the creation of a new Viewpoint

Information on a topic's viewpoint.

get

Returns Viewpoint data

get

Return a viewpoint's snapshot.

post

Add attachments to a viewpoint.

get

Return a viewpoint's file.