VisiSpecs Platform API API Outline
Read-only route inventory for the current environment. This page is informational only.
Development
Acc
| Methods | Route |
|---|---|
| GET | /api/acc/derivatives/{urn}/manifest |
| GET | /api/acc/hubs |
| GET | /api/acc/hubs/{hubId}/projects |
| GET | /api/acc/manifest |
| GET | /api/acc/projects/{projectId}/folders/{folderId}/contents |
| GET | /api/acc/projects/{projectId}/items/{lineageId}/derivative |
| GET | /api/acc/projects/{projectId}/topFolders |
| GET | /api/acc/tree |
Auth
| Methods | Route |
|---|---|
| POST | /api/auth/login |
| POST | /api/auth/logout |
| GET | /api/auth/me |
Documents
| Methods | Route |
|---|---|
| POST | /api/documents/download-word |
| GET | /api/documents/downloads/{ticket} |
| POST | /api/documents/markups |
| POST | /api/documents/render |
| GET | /api/documents/{checklistId:int}/download-word |
Health
| Methods | Route |
|---|---|
| GET | /health/live |
| GET | /health/ready |
LegacyAttachments
| Methods | Route |
|---|---|
| GET | /api/attachments/getblob/{cklistid} |
| GET | /api/attachments/{pnpid} |
LegacyAuth
| Methods | Route |
|---|---|
| POST | /api/login |
LegacyBpm
| Methods | Route |
|---|---|
| POST | /api/bpmprofile/saveBpmProfile |
| POST | /api/bpmprofile/saveBpmProfileContentFilter |
| POST | /api/bpmprofile/saveSocialMediaLinks |
| POST | /api/checklist/bpm |
| POST | /api/checklist/MainBpmLibrary |
| POST | /api/deleteBpmAd |
| POST | /api/deleteBpmSpec |
| POST | /api/getAllBpmAccounts |
| POST | /api/getBpmAdById |
| POST | /api/getBpmAds |
| POST | /api/getBpmDocRfi |
| POST | /api/projects/BPM |
| POST | /api/replaceBpmSpecContent |
| POST | /api/sendEmailToSendGrid |
| POST | /api/sendMixpanelEvent |
| POST | /api/updateBpmSpec |
| POST | /api/updateFileApprove |
| POST | /api/updateRfiComments |
| POST | /api/updateRfiOptionCompletedState |
| POST | /api/upload/ads |
| POST | /api/upload/BpmSpecs |
| POST | /api/upload/logo |
| POST | /api/upload/saveRelatedFiles |
| POST | /api/upload/specs |
LegacyCatalog
| Methods | Route |
|---|---|
| POST | /api/aliaskeys |
| POST | /api/bpmprofile/getBpmProfile |
| POST | /api/checklist/BpmSpecFromMainBpmLibrary |
| POST | /api/getinsertdocslist |
| POST | /api/getsharedfiles |
| POST | /api/insertdocsintoproject |
| POST | /api/keynotes |
| POST | /api/models |
| POST | /api/msp |
| POST | /api/projectdetails |
| POST | /api/projectlinks |
| POST | /api/projects/bpmspecs |
| POST | /api/savesharedfile |
LegacyDocuments
| Methods | Route |
|---|---|
| POST | /api/downloadWordfile |
| POST | /api/getdocfile |
| POST | /api/releaseLock |
| POST | /api/saveHyperlink |
| POST | /api/savepdfmarkup |
| POST | /api/saverelatedfile |
LegacyLinkManagement
| Methods | Route |
|---|---|
| POST | /api/keylinks |
| POST | /api/modellinks |
| POST | /api/modellinksupdate |
LegacyProjects
| Methods | Route |
|---|---|
| POST | /api/checklist |
| POST | /api/projects |
LegacyUserManagement
| Methods | Route |
|---|---|
| POST | /api/addUsersToCorpAccount |
| POST | /api/allUnassignedCorpDomainUsers |
| POST | /api/allUserRoles |
| POST | /api/email |
| POST | /api/manageUsers |
| POST | /api/registerNewUser |
| POST | /api/registerNewUserAnonymous |
| POST | /api/resetPasswordAnonymous |
| POST | /api/resetPasswordWithAccessToken |
| POST | /api/updateLoginStatus |
| POST | /api/updateUser |
ModelDerivative
| Methods | Route |
|---|---|
| POST | /api/forge/modelderivative/jobs |
| POST | /api/forge/modelderivative/views |
OAuth
| Methods | Route |
|---|---|
| GET | /api/forge/oauth/callback |
| GET | /api/forge/oauth/login |
| GET | /api/forge/oauth/token |
| GET | /api/forge/oauth/token/readonly |
OSS
| Methods | Route |
|---|---|
| POST | /api/deletefile |
| GET | /api/forge/oss/buckets |
| POST | /api/forge/oss/buckets |
| GET | /api/forge/oss/buckets/getfiles |
| POST | /api/forge/oss/objects |
| POST | /api/oss/complete-upload |
| POST | /api/oss/init-upload |
Projects
| Methods | Route |
|---|---|
| GET | /api/projects |
| GET | /api/projects/{projectId:int}/checklist |
SyncfusionDocuments
| Methods | Route |
|---|---|
| POST | /syncfusion/api/Import |
| POST | /syncfusion/api/RestrictEditing |
System
| Methods | Route |
|---|---|
| GET | /api/system/descriptor |
VisiSpecsOnline
| Methods | Route |
|---|---|
| POST | /api/visispecsonline/getBpmAds |
| POST | /api/visispecsonline/getRibbonAds |
VisiSpecsOnlineInsertDocs
| Methods | Route |
|---|---|
| POST | /api/insertdocs/searchprojects |
| POST | /api/visispecsonline/insertdocs/searchprojects |
VisiSpecsOnlineKeynotes
| Methods | Route |
|---|---|
| POST | /api/visispecsonline/keynotes/files/active-users |
| POST | /api/visispecsonline/keynotes/files/assign |
| POST | /api/visispecsonline/keynotes/files/checkin |
| POST | /api/visispecsonline/keynotes/files/checkout |
| POST | /api/visispecsonline/keynotes/files/copy |
| POST | /api/visispecsonline/keynotes/files/create |
| POST | /api/visispecsonline/keynotes/files/delete |
| POST | /api/visispecsonline/keynotes/files/heartbeat |
| POST | /api/visispecsonline/keynotes/files/lock |
| POST | /api/visispecsonline/keynotes/files/records/changes-since |
| POST | /api/visispecsonline/keynotes/files/rename |
| POST | /api/visispecsonline/keynotes/notes |
| POST | /api/visispecsonline/keynotes/records/batch-update |
| POST | /api/visispecsonline/keynotes/records/checkin |
| POST | /api/visispecsonline/keynotes/records/checkout |
| POST | /api/visispecsonline/keynotes/records/delete |
| POST | /api/visispecsonline/keynotes/records/save |
| POST | /api/visispecsonline/keynotes/workspace |
VisiSpecsOnlineLinkManagement
| Methods | Route |
|---|---|
| POST | /api/visispecsonline/linkmanagement/aliaskeys |
| POST | /api/visispecsonline/linkmanagement/projectlinks |
VisiSpecsOnlineProjects
| Methods | Route |
|---|---|
| POST | /api/visispecsonline/projects/delete |
| POST | /api/visispecsonline/projects/export |
| POST | /api/visispecsonline/projects/save-as |
| POST | /api/visispecsonline/projects/search |
VisiSpecsOnlineProjectSettings
| Methods | Route |
|---|---|
| POST | /api/visispecsonline/project-settings/create |
| POST | /api/visispecsonline/project-settings/groups |
| POST | /api/visispecsonline/project-settings/options |