Release date: 2024-10-01T12:08:58+0000
For more advanced testing, browser addons like Postman for Chrome or RESTClient for Firefox can be used. With these addons you can compose any GET/POST/PUT/DELETE/... request and save them. Information on how to compose these requests can be found in the API Documentation Index. You can also observe the calls the Bricsys 24/7 webservice makes to the server. In most browsers you can track network activity. For chrome, the F12 key opens the developers panel by default. Here in the network tab you can filter out the XHR requests, these are the ones that return human-readable text. If this stays open, and you continue to use Bricsys 24/7, you'll see a list of all requests made to the server. For each request you can view the url on which the request was performed, which parameters were used, what the payload looked like and what the response of the server was. Other browsers should have similar features available.
[] | optional part of a URL |
{} | required part of a URL to fill in |
required payload part |
URL parameter values or JSON values are either a number, a string or a boolean. The API Documentation Index also lists
custom types like WorkflowInstanceStatus or ItemType. Here an id or string is required that has a specific meaning to the server. These are enums and are listed below.
E.g. To add an Event to the server we send a post request to following URL: /api/rest/Event?{f=FolderID}
This request requires a payload containing information about the event to add. The payload has JSON attributes "Status" and "Category" which require a value of type
EventStatus and EventCategory respectively. An example payload could look like:
{
"Category": "MEETING",
"Status": "CONFIRMED",
"Description": "We will discuss the importance of the color blue in our interface.",
"Name": "Weekly Bricsys 24/7 Meeting",
"End": "1424962800000",
"Start": "1424955600000"
}
These parameters can be added to any URL
INACTIVE | 1 |
ACTIVE | 2 |
COMPLETED | 3 |
CANCELED | 4 |
LOOP | 5 |
DELETED | 6 |
OTHER | 1 |
MEETING | 2 |
TASK | 3 |
TRAVEL | 4 |
VACATION | 5 |
HOLIDAY | 6 |
CALL | 7 |
BIRTHDAY | 8 |
WORKFLOW | 9 |
NOT_APPLICABLE | 1 |
TENTATIVE | 2 |
CONFIRMED | 3 |
MEETING_CANCELED | 4 |
OPEN | 5 |
ASSIGNED | 6 |
ON_HOLD | 7 |
POSTPONED | 8 |
IN_PROGRESS | 9 |
COMPLETED25 | 10 |
COMPLETED50 | 11 |
COMPLETED75 | 12 |
COMPLETED | 13 |
DONT_SHOW_IN_CALENDAR | 15 |
CANCELED | 16 |
LOOP | 17 |
DOCUMENTS | 1 |
ADDRESSBOOK | 2 |
CALENDAR | 3 |
4 |
WORKFLOWS | 6 |
FORUM | 16 |
BINDER | 17 |
FORM | 26 |
BIM | 991 |
DRAWINGS | 992 |
RELATION | 990 |
SEPARATOR | 999 |
ITEM | 0 |
PROJECT | 1 |
FOLDER | 2 |
DOCUMENT | 3 |
CONTACT | 4 |
ORGANIZATION | 5 |
EVENT | 6 |
MESSAGE | 7 |
ROLE | 9 |
ANNOTATION | 10 |
WORKFLOW | 11 |
WORKFLOWINSTANCE | 12 |
URL | 14 |
NOTE | 16 |
NOTIFY | 17 |
FORUM | 18 |
FORUMPOST | 19 |
BINDER | 21 |
REVISION | 22 |
QUERY | 24 |
FORM | 26 |
MAILLIST | 27 |
USER | 28 |
FORMROW | 29 |
REPOSITORYLINK | 30 |
REPOSITORYTABLE | 31 |
REPOSITORYCOLUMN | 32 |
ACTIVITY | 33 |
FORMFIELD | 34 |
DOCUMENTSTATUS | 36 |
DOCUMENTVIEW | 37 |
COUNTRY | 38 |
TASK | 40 |
EVENTATTENDEE | 42 |
LOGRECENT | 43 |
LOGROOT | 44 |
LANGUAGE | 45 |
ROLEMEMBER | 46 |
FOLDERACCESS | 47 |
TRANSITIONINSTANCE | 48 |
ACTIVITYSTATE | 49 |
TRANSITION | 50 |
FORMOPTION | 52 |
FORMFIELDOPTION | 53 |
REPOSITORYTABLEACCESS | 57 |
REPOSITORYCOLUMNACCESS | 58 |
FORMRECORD | 59 |
FORMRECORDFIELD | 60 |
FOLDERSUBSCRIPTION | 61 |
AUTOWORKFLOW | 62 |
FOLDERCONTACT | 65 |
FOLDERORGANIZATION | 66 |
ACTIVITYINSTANCE | 67 |
WORKFLOWINSTANCESTATE | 68 |
ORGANIZATIONMEMBER | 70 |
APP | 71 |
REPOSITORYACCESS | 72 |
DOCUMENTSHARE | 82 |
DELAYEDNOTIFY | 84 |
FOLDERAPROPLAN | 85 |
OBJECTSETTING | 86 |
APROPLANSYNCQUEUE | 87 |
APROPLANFOLDER | 89 |
APROPLANPROJECT | 90 |
APROPLANUSER | 88 |
CUSTOMER | 91 |
RECYCLEBIN | 92 |
SEARCH | 93 |
LINKEDDOCUMENT | 94 |
BINDERITEM | 95 |
GUEST | 96 |
FOLDERACCESSSNAPSHOT | 97 |
TILE | 98 |
TILEDATA | 99 |
TILEINFO | 100 |
APPPLUGIN | 101 |
APPVISIBILITY | 102 |
CSVHEADERS | 103 |
ATTACHMENT | 104 |
LOGAPP | 105 |
BIM | 106 |
BIM_BUILDING | 108 |
BIM_STORY | 109 |
TAG | 107 |
ADMIN_ACCESS | 110 |
AUTHENTICATIONTOKEN | 111 |
ANNOTATION3D | 112 |
VIEWER_DATA | 123 |
OBJECTLINK | 127 |
XREF | 128 |
USERACCESSTOKEN | 129 |
DB_ACTIVITY_INSTANCE | 130 |
ANNOTATION2D_MARKER | 131 |
ANNOTATION3D_MARKER | 132 |
TODO | 133 |
COMMUNICATION | 134 |
WORKFLOW_COMMENT | 135 |
ANNOTATION_GENERIC | 138 |
LOOSE_WORKFLOWINSTANCE | 993 |
STORAGEENTRY | 994 |
STORAGE | 995 |
STORAGELOCATION | 996 |
FILELOCATION | 997 |
LOG | 998 |
ALL | -1 |
LOWEST | 10 |
LOW | 20 |
NORMAL | 30 |
HIGH | 40 |
HIGHEST | 50 |
HOUR | 10 |
DAY | 5 |
WEEK | 3 |
MONTH | 2 |
DAY | 5 |
WEEK | 3 |
MONTH | 2 |
YEAR | 1 |
NEW | 0 |
RELEASED | 20 |
OBSOLETE | 30 |
/api/rest/DocumentRevision?[doc=DocumentID][&f=FolderID][&format=IOType][&limit=Integer][&offset=Integer][&p=ProjectID][&r=DocumentRevisionID][&revision=Integer][&sharetoken=ShareTokenID][&tag=String]
DOCUMENT (doc) | DocumentID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | DocumentRevisionID |
REVISION (revision) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/DocumentRevision?[f=FolderID][&format=IOType]{&r=DocumentRevisionID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/DocumentRevision?a=PRINT[&f=FolderID][&format=IOType][&p=ProjectID]{&r=DocumentRevisionID}[&sharetoken=ShareTokenID]{&timezone=TimeZoneID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE (timezone) | TimeZoneID |
/api/rest/DocumentRevision?a=DOWNLOAD[&f=FolderID][&format=IOType]{&r=DocumentRevisionID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/DocumentRevision?a=QRCODE[&atype=String][&f=FolderID][&format=IOType]{&r=DocumentRevisionID}[&sharetoken=ShareTokenID][&size=Integer]
ACTIONTYPE (atype) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
SIZE (size) | Integer (ID or number) |
/api/rest/ActivityTask?[activity=ActivityID][&f=FolderID][&format=IOType][&sharetoken=ShareTokenID][&wfi=WorkflowInstanceID][&wfi_state=WorkflowInstanceStateID]
ACTIVITY (activity) | ActivityID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
WORKFLOW_INSTANCE_STATE (wfi_state) | WorkflowInstanceStateID |
/api/rest/ActivityTask?a=SETACTOR{&activity=ActivityID}[&actor=Integer][&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&wfi=WorkflowInstanceID}
ACTIVITY (activity) | ActivityID |
ACTOR (actor) | Integer (ID or number) |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
/api/rest/ActivityTask?a=SETSTATE{&activity=ActivityID}[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&wfi=WorkflowInstanceID}
ACTIVITY (activity) | ActivityID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
This call requires a request payload that should look like:
{
"StateID": int,
"CommentAsNote": boolean,
"ObjectID": int,
"LinkToDocumentIDs": [Integer],
"SkipJob": boolean,
"Comment": String
}
/api/rest/AdminAccess?[f=FolderID][&format=IOType]{&p=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/AdminAccess?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Contact": int,
"CanManageProjectSettings": boolean,
"CanManageUserRoles": boolean,
"CanManageFolderStructure": boolean,
"CanManageFolderAccess": boolean,
"CanManageTableAccess": boolean,
"CanManageExternalAppAccess": boolean,
"CanManageAuditReport": boolean,
"CanManageRecycleBin": boolean,
"CanManageAdministrators": boolean,
"ID": int,
"Project": int,
"ObjectType": ItemType
}
/api/rest/AdminAccess?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"AdminAccess": [
{
"Contact": int,
"CanManageProjectSettings": boolean,
"CanManageUserRoles": boolean,
"CanManageFolderStructure": boolean,
"CanManageFolderAccess": boolean,
"CanManageTableAccess": boolean,
"CanManageExternalAppAccess": boolean,
"CanManageAuditReport": boolean,
"CanManageRecycleBin": boolean,
"CanManageAdministrators": boolean,
"ID": int,
"Project": int,
"ObjectType": ItemType
}
]
}
/api/rest/Annotation2D?[dv=DocumentViewID][&f=FolderID][&format=IOType][&pg=Integer][&r=Annotation2DID][&revision=DocumentRevisionID][&sharetoken=ShareTokenID][&tag=String]
DOCUMENT_VIEW (dv) | DocumentViewID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PAGE (pg) | Integer (ID or number) |
RECORD (r) | Annotation2DID |
REVISION (revision) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Annotation2D?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"DocumentView": int,
"ToID": [Integer],
"RegionY": int,
"RegionX": int,
"RegionW": int,
"RegionH": int,
"Shape": int,
"Page": int,
"Subject": String,
"Body": String,
"Public": boolean
}
/api/rest/Annotation3D?[f=FolderID][&format=IOType][&r=Annotation3DID][&revision=DocumentRevisionID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | Annotation3DID |
REVISION (revision) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Annotation3D?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"AnchorX": double,
"AnchorY": double,
"AnchorZ": double,
"LeaderX": double,
"LeaderY": double,
"LeaderZ": double,
"ObjectID": String,
"Revision": int,
"ToID": [Integer],
"Subject": String,
"Body": String,
"Public": boolean
}
/api/rest/App?a=RUN{&app=AppID}[&f=FolderID][&format=IOType]{&itemkey=ItemID}[&sharetoken=ShareTokenID]
APP (app) | AppID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/AppVisibility?[f=FolderID][&format=IOType][&r=AppVisibilityID]{&role=RoleID}[&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | AppVisibilityID |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/FolderAproPlan?[f=FolderID][&format=IOType][&p=ProjectID][&r=FolderAproPlanID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | FolderAproPlanID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/FolderAproPlan?{alias=String}{&aproplanfolder=String}{&f=FolderID}[&format=IOType]{&password=String}{&aproplanproject=String}[&sharetoken=ShareTokenID]
ALIAS (alias) | String |
APROPLAN_FOLDER (aproplanfolder) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PASSWORD (password) | String |
APROPLAN_PROJECT (aproplanproject) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FolderAproPlan?[f=FolderID][&format=IOType]{&r=FolderAproPlanID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FolderAproPlanID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Password": String,
"Username": String
}
/api/rest/FolderAproPlan?[f=FolderID][&format=IOType]{&r=FolderAproPlanID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FolderAproPlanID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/AproPlanFolder?{alias=String}[&f=FolderID][&format=IOType][&parent=String]{&password=String}[&aproplanproject=String][&r=AproPlanFolderID][&sharetoken=ShareTokenID][&tag=String]
ALIAS (alias) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PARENT (parent) | String |
PASSWORD (password) | String |
APROPLAN_PROJECT (aproplanproject) | String |
RECORD (r) | AproPlanFolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/AproPlanProject?{alias=String}[&f=FolderID][&format=IOType]{&password=String}[&r=AproPlanProjectID][&sharetoken=ShareTokenID][&tag=String]
ALIAS (alias) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PASSWORD (password) | String |
RECORD (r) | AproPlanProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/AproPlanSyncQueue?{f=FolderID}[&format=IOType][&r=AproPlanSyncQueueID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | AproPlanSyncQueueID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/AproPlanUser?a=LOGIN_SECURE[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Password": String,
"Username": String
}
/api/rest/Attachment?[f=FolderID][&format=IOType]{&itemkey=String}[&name=String][&p=ProjectID][&r=AttachmentID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | String |
NAME (name) | String |
PROJECT (p) | ProjectID |
RECORD (r) | AttachmentID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Attachment?[f=FolderID][&format=IOType]{&itemkey=ItemID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Items": [
{
"FileName": String,
"Name": String,
"Description": String
}
]
}
/api/rest/Attachment?[f=FolderID][&format=IOType][&itemkey=ItemID]{&r=AttachmentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
RECORD (r) | AttachmentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Attachment?a=DOWNLOAD[&f=FolderID][&format=IOType][&itemkey=String]{&r=AttachmentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | String |
RECORD (r) | AttachmentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Attachment?a=PREVIEW[&dv=Integer][&f=FolderID][&format=IOType][&pg=Integer]{&r=AttachmentID}[&sharetoken=ShareTokenID]
DOCUMENT_VIEW (dv) | Integer (ID or number) |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PAGE (pg) | Integer (ID or number) |
RECORD (r) | AttachmentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/AutoWorkflow?[admin=String][&f=FolderID][&format=IOType]{&p=ProjectID}[&r=AutoWorkflowID][&sharetoken=ShareTokenID][&tag=String]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | AutoWorkflowID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/AutoWorkflow?[cancelprefwf=Boolean][&coordinator=Integer]{&f=FolderID}[&format=IOType]{&revision=Boolean}[&sharetoken=ShareTokenID][&subfolders=Boolean]{&workflow=WorkflowID}
CANCEL_PREV_WF (cancelprefwf) | Boolean |
COORDINATOR (coordinator) | Integer (ID or number) |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
REVISION (revision) | Boolean |
SHARETOKEN (sharetoken) | ShareTokenID |
SUBFOLDERS (subfolders) | Boolean |
WORKFLOW (workflow) | WorkflowID |
/api/rest/AutoWorkflow?{autoworkflow=AutoWorkflowID}[&cancelprefwf=Boolean][&coordinator=Integer]{&f=FolderID}[&format=IOType]{&revision=Boolean}[&sharetoken=ShareTokenID][&subfolders=Boolean]{&workflow=WorkflowID}
AUTOWORKFLOW (autoworkflow) | AutoWorkflowID |
CANCEL_PREV_WF (cancelprefwf) | Boolean |
COORDINATOR (coordinator) | Integer (ID or number) |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
REVISION (revision) | Boolean |
SHARETOKEN (sharetoken) | ShareTokenID |
SUBFOLDERS (subfolders) | Boolean |
WORKFLOW (workflow) | WorkflowID |
/api/rest/AutoWorkflow?[f=FolderID][&format=IOType]{&r=AutoWorkflowID}[&sharetoken=ShareTokenID][&subfolders=Boolean]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | AutoWorkflowID |
SHARETOKEN (sharetoken) | ShareTokenID |
SUBFOLDERS (subfolders) | Boolean |
/api/rest/AutoWorkflow?a=COPY[&f=FolderID][&format=IOType]{&from=FolderID}[&sharetoken=ShareTokenID]{&to=FolderID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FROM (from) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
TO (to) | FolderID |
/api/rest/Bim?[bimrecord=Integer][&building=Integer]{&f=FolderID}[&format=IOType]{&model=Integer}[&modelversion=String][&parenttype=String][&parentidentifier=String][&r=BimID][&recursive=Boolean][&sharetoken=ShareTokenID][&story=Integer][&tag=String]
BIM_RECORD (bimrecord) | Integer (ID or number) |
BUILDING (building) | Integer (ID or number) |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MODEL (model) | Integer (ID or number) |
MODEL_VERSION (modelversion) | String |
PARENT_TYPE (parenttype) | String |
PARENT_IDENTIFIER (parentidentifier) | String |
RECORD (r) | BimID |
RECURSIVE (recursive) | Boolean |
SHARETOKEN (sharetoken) | ShareTokenID |
STORY (story) | Integer (ID or number) |
TAG (tag) | String |
/api/rest/BinderItem?{f=FolderID}[&format=IOType][&limit=Integer][&offset=Integer][&r=ItemID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
RECORD (r) | ItemID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/BinderItem?a=ADD_TO_BINDER{&f=FolderID}[&format=IOType]{&itemkey=ItemID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/BinderItem?a=REMOVE_FROM_BINDER{&f=FolderID}[&format=IOType]{&itemkey=ItemID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/BimBuilding?[f=FolderID][&format=IOType]{&model=Integer}[&modelversion=String][&r=BimBuildingID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MODEL (model) | Integer (ID or number) |
MODEL_VERSION (modelversion) | String |
RECORD (r) | BimBuildingID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Contact?[admin=Boolean][&f=FolderID][&format=IOType][&limit=Integer][&offset=Integer][&p=ProjectID][&r=ContactID][&sharetoken=ShareTokenID][&tag=String]
ADMIN (admin) | Boolean |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Contact?[f=FolderID][&format=IOType][&image=FileID][&p=ProjectID][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
IMAGE (image) | FileID |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"OrganizationsID": [Integer],
"Function": String,
"Language": int,
"State": String,
"Address": String,
"City": String,
"Fax": String,
"Mobile": String,
"Phone": String,
"Zip": String,
"Email": String,
"FirstName": String,
"LastName": String,
"CountryID": int
}
/api/rest/Contact?[f=FolderID][&format=IOType][&p=ProjectID]{&r=ContactID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"OrganizationsID": [Integer],
"Function": String,
"Language": int,
"State": String,
"Address": String,
"City": String,
"Fax": String,
"Mobile": String,
"Phone": String,
"Zip": String,
"Email": String,
"FirstName": String,
"LastName": String,
"CountryID": int
}
/api/rest/Contact?{f=FolderID}[&format=IOType]{&r=ContactID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=MOVE{&f=FolderID}[&format=IOType]{&from=FolderID}{&r=ContactID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FROM (from) | FolderID |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=COPY{&f=FolderID}[&format=IOType]{&from=FolderID}{&r=ContactID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FROM (from) | FolderID |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=PRINT{&f=FolderID}[&format=IOType][&p=ProjectID][&r=ContactID][&sharetoken=ShareTokenID]{&timezone=TimeZoneID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE (timezone) | TimeZoneID |
/api/rest/Contact?a=IMPORT{&f=FolderID}[&format=IOType]{&r=ContactID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=SEARCH[&all=Boolean][&byusername=Boolean][&f=FolderID][&format=IOType][&p=ProjectID][&root=Boolean]{&s=String}[&sharetoken=ShareTokenID]
ALL (all) | Boolean |
BY_USERNAME (byusername) | Boolean |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
ROOT (root) | Boolean |
SEARCH (s) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=DOWNLOAD{&f=FolderID}[&format=IOType]{&r=ContactID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=PREVIEW[&default value=Boolean][&f=FolderID][&format=IOType]{&r=ContactID}[&sharetoken=ShareTokenID]
DEFAULT_VALUE (default value) | Boolean |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=IMPORTCSV{&file=String}{&f=FolderID}[&format=IOType]{&mapping=String}[&r=ContactID][&sharetoken=ShareTokenID]
FILE (file) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MAPPING (mapping) | String |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=NEW_MAIL[&f=FolderID][&format=IOType][&message=String]{&p=ProjectID}{&r=ContactID}[&resend=Boolean][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MESSAGE (message) | String |
PROJECT (p) | ProjectID |
RECORD (r) | ContactID |
RESEND (resend) | Boolean |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=CHANGE_IMAGE{&f=FolderID}[&format=IOType][&image=FileID]{&r=ContactID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
IMAGE (image) | FileID |
RECORD (r) | ContactID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Country?[f=FolderID][&format=IOType][&r=CountryID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | CountryID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Customer?a=PREVIEW[&default value=Boolean][&f=FolderID][&format=IOType]{&r=CustomerID}[&sharetoken=ShareTokenID]
DEFAULT_VALUE (default value) | Boolean |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | CustomerID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Customer?a=CHANGE_IMAGE[&f=FolderID][&format=IOType][&image=FileID]{&r=CustomerID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
IMAGE (image) | FileID |
RECORD (r) | CustomerID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?[doc=DocumentID][&f=FolderID][&format=IOType][&limit=Integer][&name=String][&offset=Integer][&p=ProjectID][&r=DocumentID][&revision=DocumentRevisionID][&sharetoken=ShareTokenID][&sort=SortValueID][&tag=String]
DOCUMENT (doc) | DocumentID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
NAME (name) | String |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | DocumentID |
REVISION (revision) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
SORT (sort) | SortValueID |
TAG (tag) | String |
Getting information about document revisions is done by doing the filter call of the document and adding the universal parameter &EXPAND=REVISION.
/api/rest/Document?{f=FolderID}[&format=IOType][&r=DocumentID][&sharetoken=ShareTokenID][&timezone=TimeZoneID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE (timezone) | TimeZoneID |
This call requires a request payload that should look like:
{
"Items": [
{
"FileName": String,
"UseOrgFileName": boolean,
"StatusID": int,
"MetaData": [
}
],
"DocumentID": int,
"Unzip": boolean,
"ReplaceLastRevision": boolean,
"Content": String,
"Name": String,
"Description": String,
"Charset": String,
"Tags": [String]
}
]
}
This call is used to send information about a newly added document to the server. This only works if the document file itself has already been uploaded. Uploading the file can be done by doing a multipart/formdata HTTP POST request to following url:
/api/servlet.gupld
While creating this request you'll have to provide a name and a path to the file. Wait until the upload document file call is completed before doing the second POST call with the chapoo information as described in this section. The server will match the uploaded file of the first call with the information of the second call by matching the provided name of the first call with the payload FileName json attribute of the second call. As long as these Strings are identical the server will use them together. The payload Name json attribute is the eventual document name displayed by the system. FileName and Name are allowed to be different.
When a DocumentID is provided in the payload, the newly uploaded file will be added as revision of matching Document with given ID.
/api/rest/Document?[f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID][&status=DocumentStatusID][&timezone=TimeZoneID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
STATUS (status) | DocumentStatusID |
TIMEZONE (timezone) | TimeZoneID |
This call requires a request payload that should look like:
{
"StatusID": int,
"MetaData": [
}
],
"Name": String,
"Description": String
}
/api/rest/Document?[f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=MOVE{&f=FolderID}[&format=IOType][&name=String]{&r=DocumentID}[&sharetoken=ShareTokenID][&status=DocumentStatusID][&timezone=TimeZoneID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
NAME (name) | String |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
STATUS (status) | DocumentStatusID |
TIMEZONE (timezone) | TimeZoneID |
This call requires a request payload that should look like:
{
"Items": [
{
"FileName": String,
"UseOrgFileName": boolean,
"StatusID": int,
"MetaData": [
}
],
"DocumentID": int,
"Unzip": boolean,
"ReplaceLastRevision": boolean,
"Content": String,
"Name": String,
"Description": String,
"Charset": String,
"Tags": [String]
}
]
}
/api/rest/Document?a=COPY[&all=Boolean]{&f=FolderID}[&format=IOType][&message=Boolean][&name=String]{&r=DocumentID}[&revision=DocumentRevisionID][&sharetoken=ShareTokenID][&status=DocumentStatusID][&target=DocumentID][&timezone=TimeZoneID]
ALL (all) | Boolean |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MESSAGE (message) | Boolean |
NAME (name) | String |
RECORD (r) | DocumentID |
REVISION (revision) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
STATUS (status) | DocumentStatusID |
TARGET (target) | DocumentID |
TIMEZONE (timezone) | TimeZoneID |
This call requires a request payload that should look like:
{
"Items": [
{
"FileName": String,
"UseOrgFileName": boolean,
"StatusID": int,
"MetaData": [
}
],
"DocumentID": int,
"Unzip": boolean,
"ReplaceLastRevision": boolean,
"Content": String,
"Name": String,
"Description": String,
"Charset": String,
"Tags": [String]
}
]
}
/api/rest/Document?a=PRINT[&f=FolderID][&format=IOType][&pg=Integer][&p=ProjectID]{&r=DocumentID}[&revision=Integer][&sharetoken=ShareTokenID]{&timezone=TimeZoneID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PAGE (pg) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | DocumentID |
REVISION (revision) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE (timezone) | TimeZoneID |
/api/rest/Document?a=SEARCH[&after=String][&before=String][&contact=String][&content=String][&description=String][&extension=String][&f=FolderID][&format=IOType][&name=String][&offset=Integer]{&p=ProjectID}[&reservations=Boolean][&sharetoken=ShareTokenID][&status=DocumentStatusID]
AFTER (after) | String |
BEFORE (before) | String |
CONTACT (contact) | String |
CONTENT (content) | String |
DESCRIPTION (description) | String |
EXTENSION (extension) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
NAME (name) | String |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RESERVATIONS (reservations) | Boolean |
SHARETOKEN (sharetoken) | ShareTokenID |
STATUS (status) | DocumentStatusID |
/api/rest/Document?a=DOWNLOAD[&f=FolderID][&format=IOType][&includelinks=Boolean][&lock=Boolean][&r=DocumentID][&revision=DocumentRevisionID][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
INCLUDE_LINKS (includelinks) | Boolean |
LOCK (lock) | Boolean |
RECORD (r) | DocumentID |
REVISION (revision) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=PREVIEW[&f=FolderID][&format=IOType][&height=Integer][&pg=Integer]{&r=DocumentID}[&revision=Integer][&sharetoken=ShareTokenID][&vw=Integer][&width=Integer]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
HEIGHT (height) | Integer (ID or number) |
PAGE (pg) | Integer (ID or number) |
RECORD (r) | DocumentID |
REVISION (revision) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
VIEW (vw) | Integer (ID or number) |
WIDTH (width) | Integer (ID or number) |
/api/rest/Document?a=LOCK[&f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=UNLOCK[&f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=WORKFLOWATTACH[&f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"CoordinatorID": int,
"WorkflowID": int,
"Name": String,
"Description": String,
"Status": EventStatus
}
/api/rest/Document?a=SHARE[&f=FolderID][&format=IOType][&name=String]{&r=DocumentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
NAME (name) | String |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=ADD_RESERVATION[&description=String]{&f=FolderID}[&format=IOType]{&reservations=Integer}[&sharetoken=ShareTokenID]{&status=DocumentStatusID}[&timezone=TimeZoneID]
DESCRIPTION (description) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RESERVATIONS (reservations) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
STATUS (status) | DocumentStatusID |
TIMEZONE (timezone) | TimeZoneID |
This call requires a request payload that should look like:
{
"FormRecords": [
}
]
}
/api/rest/Document?a=DISABLE_SHARE[&f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=QRCODE[&atype=String][&f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID][&size=Integer]
ACTIONTYPE (atype) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
SIZE (size) | Integer (ID or number) |
/api/rest/Document?a=SET_STATUS[&f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID]{&status=DocumentStatusID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
STATUS (status) | DocumentStatusID |
/api/rest/Document?a=REMOVE_FROM_STORAGE[&f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=PROMOTE_MAJOR_VERSION[&f=FolderID][&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=NEW_MAIL[&f=FolderID][&format=IOType][&message=String]{&r=DocumentID}[&sharetoken=ShareTokenID]{&to=String}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MESSAGE (message) | String |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
TO (to) | String |
/api/rest/DocumentShare?[doc=DocumentID][&f=FolderID][&format=IOType][&r=DocumentShareID][&sharetoken=ShareTokenID][&tag=String]
DOCUMENT (doc) | DocumentID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | DocumentShareID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/DocumentStatus?[f=FolderID][&format=IOType]{&p=ProjectID}[&r=DocumentStatusID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | DocumentStatusID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/DocumentStatus?[f=FolderID][&format=IOType]{&p=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Name": String,
"Sequence": int
}
/api/rest/DocumentStatus?[f=FolderID][&format=IOType]{&p=ProjectID}{&r=DocumentStatusID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | DocumentStatusID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Name": String,
"Sequence": int
}
/api/rest/DocumentStatus?[f=FolderID][&format=IOType]{&p=ProjectID}{&r=DocumentStatusID}[&replace=DocumentStatusID][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | DocumentStatusID |
REPLACE (replace) | DocumentStatusID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Event?[before=String][&end=String][&event=EventID][&f=FolderID][&format=IOType][&limit=Integer][&offset=Integer][&p=ProjectID][&r=EventID][&sharetoken=ShareTokenID][&start=String][&tag=String]
BEFORE (before) | String |
END (end) | String |
EVENT (event) | EventID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | EventID |
SHARETOKEN (sharetoken) | ShareTokenID |
START (start) | String |
TAG (tag) | String |
/api/rest/Event?{f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]{&tzstart=String}{&tzend=String}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE_START (tzstart) | String |
TIMEZONE_END (tzend) | String |
This call requires a request payload that should look like:
{
"Name": String,
"Start": Date,
"Description": String,
"End": Date,
"Reminder":
{
"ContactIDs": [Integer],
"MailListIDs": [Integer],
"Value": int,
"Type": ReminderType
},
"Status": EventStatus,
"Category": EventCategory,
"AttendeeIDs": [Integer],
"AskConfirmation": boolean,
"informAttendees": boolean,
"AttachmentNames": [String],
"AttachmentIDs": [Integer],
"Repeat":
{
"Value": int,
"End": Date,
"Type": RepeatType
},
"AttendeeMailListIDs": [Integer]
}
/api/rest/Event?[f=FolderID][&format=IOType]{&r=EventID}[&sharetoken=ShareTokenID]{&tzstart=String}{&tzend=String}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | EventID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE_START (tzstart) | String |
TIMEZONE_END (tzend) | String |
This call requires a request payload that should look like:
{
"ApplyToFutureEvents": [Integer],
"Name": String,
"Start": Date,
"Description": String,
"End": Date,
"Reminder":
{
"ContactIDs": [Integer],
"MailListIDs": [Integer],
"Value": int,
"Type": ReminderType
},
"Status": EventStatus,
"Category": EventCategory,
"AttendeeIDs": [Integer],
"AskConfirmation": boolean,
"informAttendees": boolean,
"AttachmentNames": [String],
"AttachmentIDs": [Integer],
"Repeat":
{
"Value": int,
"End": Date,
"Type": RepeatType
},
"AttendeeMailListIDs": [Integer]
}
/api/rest/Event?[f=FolderID][&format=IOType][&future=Boolean]{&r=EventID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FUTURE (future) | Boolean |
RECORD (r) | EventID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Event?a=PRINT[&f=FolderID][&format=IOType][&p=ProjectID]{&r=EventID}[&sharetoken=ShareTokenID]{&timezone=TimeZoneID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | EventID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE (timezone) | TimeZoneID |
/api/rest/Event?a=DOWNLOAD[&f=FolderID][&format=IOType]{&r=EventID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | EventID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/EventAttendee?a=CONFIRM[&f=FolderID][&format=IOType]{&r=EventAttendeeID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | EventAttendeeID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/EventAttendee?a=DENY[&f=FolderID][&format=IOType]{&r=EventAttendeeID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | EventAttendeeID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Folder?[admin=String][&all=Boolean][&children=Boolean][&f=FolderID][&ftype=FolderType][&format=IOType][&o=Integer][&ot=ItemType][&parent=FolderID][&p=ProjectID][&r=FolderID][&sharetoken=ShareTokenID][&tag=String][&u=Integer][&wfi=WorkflowInstanceID]
ADMIN (admin) | String |
ALL (all) | Boolean |
CHILDREN (children) | Boolean |
FOLDER (f) | FolderID |
FOLDER_TYPE (ftype) | FolderType |
FORMAT (format) | IOType |
OBJECT_ID (o) | Integer (ID or number) |
OBJECT_TYPE (ot) | ItemType |
PARENT (parent) | FolderID |
PROJECT (p) | ProjectID |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
USER (u) | Integer (ID or number) |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
/api/rest/Folder?[admin=String][&before=FolderID][&f=FolderID][&format=IOType][&image=FileID][&parent=FolderID][&p=ProjectID][&sharetoken=ShareTokenID]
ADMIN (admin) | String |
BEFORE (before) | FolderID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
IMAGE (image) | FileID |
PARENT (parent) | FolderID |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"BinderDocumentStatus": boolean,
"DocumentStatusID": [Integer],
"MailFunctionality": boolean,
"PreventSimultaneousEvents": boolean,
"StartOfDay": Date,
"EndOfDay": Date,
"Path": String,
"Name": String,
"Description": String,
"Server": String,
"Password": String,
"Username": String,
"ProjectID": int,
"Sequence": int,
"FolderType": FolderType,
"FixedEventDuration": String
}
/api/rest/Folder?[admin=String][&f=FolderID][&format=IOType]{&r=FolderID}[&sharetoken=ShareTokenID]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"BinderDocumentStatus": boolean,
"DocumentStatusID": [Integer],
"MailFunctionality": boolean,
"PreventSimultaneousEvents": boolean,
"StartOfDay": Date,
"EndOfDay": Date,
"Path": String,
"Name": String,
"Description": String,
"Server": String,
"Password": String,
"Username": String,
"ProjectID": int,
"Sequence": int,
"FolderType": FolderType,
"FixedEventDuration": String
}
/api/rest/Folder?[f=FolderID][&format=IOType]{&r=FolderID}[&sharetoken=ShareTokenID][&simulate=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
SIMULATE (simulate) | String |
/api/rest/Folder?a=MOVE[&before=FolderID][&f=FolderID][&format=IOType][&parent=Integer]{&r=FolderID}[&sharetoken=ShareTokenID]
BEFORE (before) | FolderID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PARENT (parent) | Integer (ID or number) |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Folder?a=COPY[&before=FolderID][&f=FolderID][&format=IOType][&name=String][&p=ProjectID]{&r=FolderID}[&sharetoken=ShareTokenID]{&subfolders=Boolean}[&to=FolderID]
BEFORE (before) | FolderID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
NAME (name) | String |
PROJECT (p) | ProjectID |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
SUBFOLDERS (subfolders) | Boolean |
TO (to) | FolderID |
/api/rest/Folder?a=SEARCH[&f=FolderID][&format=IOType]{&p=ProjectID}[&sharetoken=ShareTokenID][&u=UserID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
USER (u) | UserID |
/api/rest/Folder?a=HISTORY{&f=FolderID}[&format=IOType][&offset=Integer][&r=LogID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
OFFSET (offset) | Integer (ID or number) |
RECORD (r) | LogID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Folder?a=PREVIEW[&default value=Boolean][&f=FolderID][&format=IOType]{&r=FolderID}[&sharetoken=ShareTokenID]
DEFAULT_VALUE (default value) | Boolean |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Folder?a=SHARE[&f=FolderID][&format=IOType]{&r=FolderID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Folder?a=DISABLE_SHARE[&f=FolderID][&format=IOType]{&r=FolderID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Folder?a=CHANGE_IMAGE[&f=FolderID][&format=IOType][&image=FileID]{&r=FolderID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
IMAGE (image) | FileID |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FolderAccess?[f=FolderID][&format=IOType][&p=ProjectID][&r=FolderAccessID][&role=RoleID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | FolderAccessID |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/FolderAccess?{f=FolderID}[&format=IOType][&role=RoleID][&sharetoken=ShareTokenID][&subfolders=Boolean]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
SUBFOLDERS (subfolders) | Boolean |
This call requires a request payload that should look like:
{
"Delete": boolean,
"ViewOwn": boolean,
"Print": boolean,
"Download": boolean,
"Add": boolean,
"AddRevision": boolean,
"AddRevisionOwn": boolean,
"Annotate": boolean,
"Edit": boolean,
"EditOwn": boolean,
"DeleteOwn": boolean,
"AttachWorkflow": boolean,
"AttachWorkflowOwn": boolean,
"AddSubfolder": boolean,
"Share": boolean,
"ShareOwn": boolean,
"AttachForm": boolean,
"AttachFormOwn": boolean,
"View": boolean
}
/api/rest/FolderAccess?[f=FolderID][&format=IOType][&role=RoleID][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"FolderAccess": {
String:
{
"Delete": boolean,
"ViewOwn": boolean,
"Print": boolean,
"Download": boolean,
"Add": boolean,
"AddRevision": boolean,
"AddRevisionOwn": boolean,
"Annotate": boolean,
"Edit": boolean,
"EditOwn": boolean,
"DeleteOwn": boolean,
"AttachWorkflow": boolean,
"AttachWorkflowOwn": boolean,
"AddSubfolder": boolean,
"Share": boolean,
"ShareOwn": boolean,
"AttachForm": boolean,
"AttachFormOwn": boolean,
"View": boolean
}
}
}
/api/rest/FolderAccess?a=COPY{&f=FolderID}[&format=IOType]{&parent=FolderID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PARENT (parent) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FolderAccessSnapshot?[f=FolderID][&format=IOType]{&p=ProjectID}[&r=FolderAccessSnapshotID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | FolderAccessSnapshotID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/FolderAccessSnapshot?[f=FolderID][&format=IOType]{&r=FolderAccessSnapshotID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FolderAccessSnapshotID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FolderAccessSnapshot?a=PREVIEW[&f=FolderID]{&snapshot=FolderAccessSnapshotID}[&format=IOType]{&p=ProjectID}[&r=FolderID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FOLDERACCESS_SNAPSHOT (snapshot) | FolderAccessSnapshotID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/FolderAccessSnapshot?a=CREATE[&f=FolderID][&format=IOType]{&name=String}{&p=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
NAME (name) | String |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FolderAccessSnapshot?a=REVERT[&f=FolderID][&format=IOType]{&p=ProjectID}{&r=FolderAccessSnapshotID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | FolderAccessSnapshotID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FolderSubscription?[admin=String][&f=FolderID][&format=IOType][&p=ProjectID][&r=FolderSubscriptionID][&sharetoken=ShareTokenID][&tag=String]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | FolderSubscriptionID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/FolderSubscription?[admin=String][&f=FolderID][&format=IOType]{&hour=Integer}[&p=ProjectID][&sharetoken=ShareTokenID]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
HOUR (hour) | Integer (ID or number) |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FolderSubscription?[admin=String][&f=FolderID][&format=IOType]{&hour=Integer}{&p=ProjectID}[&sharetoken=ShareTokenID]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
HOUR (hour) | Integer (ID or number) |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FolderSubscription?[admin=String][&f=FolderID][&format=IOType][&p=ProjectID][&sharetoken=ShareTokenID]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Form?[admin=String][&f=FolderID][&format=IOType][&itemkey=ItemID][&metadata=Boolean][&p=ProjectID][&r=FormID][&sharetoken=ShareTokenID][&tag=String]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
METADATA (metadata) | Boolean |
PROJECT (p) | ProjectID |
RECORD (r) | FormID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Form?{f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Name": String,
"FormField": [
{
"Name": String,
"Parent": int,
"Form": int,
"ID": int,
"Required": boolean,
"Width": int,
"Height": int,
"Options": [
{
"ID": int,
"FormField": int,
"ObjectType": ItemType,
"Name": String,
"Value": String
}
],
"Rights": [
{
"Role": int,
"FormField": int,
"Column": int,
"CanView": boolean,
"CanAdd": boolean,
"CanEdit": boolean
}
],
"Sequence": int,
"Column": int,
"OrgID": int,
"FormFieldType": int,
"X": int,
"Y": int,
"Children": [FormFieldPayload],
"ObjectType": ItemType
}
],
"ID": int,
"Options": [
{
"ID": int,
"ObjectType": ItemType,
"Name": String,
"Value": String
}
],
"Rights": [
{
"Form": int,
"Role": int,
"Table": int,
"CanView": boolean,
"CanAdd": boolean,
"CanEdit": boolean,
"CanDelete": boolean
}
],
"Folder": int,
"Author": int,
"Table": int,
"ObjectType": ItemType
}
/api/rest/Form?{f=FolderID}[&format=IOType]{&r=FormID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FormID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Name": String,
"FormField": [
{
"Name": String,
"Parent": int,
"Form": int,
"ID": int,
"Required": boolean,
"Width": int,
"Height": int,
"Options": [
{
"ID": int,
"FormField": int,
"ObjectType": ItemType,
"Name": String,
"Value": String
}
],
"Rights": [
{
"Role": int,
"FormField": int,
"Column": int,
"CanView": boolean,
"CanAdd": boolean,
"CanEdit": boolean
}
],
"Sequence": int,
"Column": int,
"OrgID": int,
"FormFieldType": int,
"X": int,
"Y": int,
"Children": [FormFieldPayload],
"ObjectType": ItemType
}
],
"ID": int,
"Options": [
{
"ID": int,
"ObjectType": ItemType,
"Name": String,
"Value": String
}
],
"Rights": [
{
"Form": int,
"Role": int,
"Table": int,
"CanView": boolean,
"CanAdd": boolean,
"CanEdit": boolean,
"CanDelete": boolean
}
],
"Folder": int,
"Author": int,
"Table": int,
"ObjectType": ItemType
}
/api/rest/Form?[f=FolderID][&format=IOType]{&r=FormID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FormID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Form?a=MOVE{&f=FolderID}[&format=IOType][&name=String]{&r=FormID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
NAME (name) | String |
RECORD (r) | FormID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Form?a=COPY[©data=Boolean]{&f=FolderID}[&format=IOType][&name=String]{&r=FormID}[&sharetoken=ShareTokenID]
COPY_DATA (copydata) | Boolean |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
NAME (name) | String |
RECORD (r) | FormID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FormRow?[f=FolderID][&form=FormID][&format=IOType][&itemkey=ItemID][&r=FormRowID][&row=Integer][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
RECORD (r) | FormRowID |
ROW (row) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/FormRow?[f=FolderID]{&form=FormID}[&format=IOType]{&o=Integer}{&ot=ItemType}{&row=Integer}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
OBJECT_ID (o) | Integer (ID or number) |
OBJECT_TYPE (ot) | ItemType |
ROW (row) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FormRow?[f=FolderID][&form=FormID][&format=IOType][&itemkey=ItemID]{&r=FormRowID}[&row=Integer][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
RECORD (r) | FormRowID |
ROW (row) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FormRecord?[doc=DocumentID][&f=FolderID][&form=FormID][&format=IOType][&limit=Integer][&o=Integer][&offset=Integer][&r=FormID][&references=Boolean][&revision=DocumentRevisionID][&row=Integer][&sharetoken=ShareTokenID]
DOCUMENT (doc) | DocumentID |
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OBJECT_ID (o) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
RECORD (r) | FormID |
REFERENCES (references) | Boolean |
REVISION (revision) | DocumentRevisionID |
ROW (row) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FormRecord?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/FormRecord?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/FormRecord?[f=FolderID][&format=IOType]{&r=FormID}[&row=Integer][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | FormID |
ROW (row) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FormRecord?a=SEARCH[&f=FolderID][&format=IOType][&key=String][&metadata=Boolean][&operator=String][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
KEY (key) | String |
METADATA (metadata) | Boolean |
OPERATOR (operator) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/FormRecord?a=LINK[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&source=FormID}{&sourceids=Integer}{&target=FormID}{&targetids=Integer}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
SOURCE (source) | FormID |
SOURCEIDS (sourceids) | Integer (ID or number) |
TARGET (target) | FormID |
TARGETIDS (targetids) | Integer (ID or number) |
/api/rest/ForumPost?[f=FolderID][&format=IOType][&forumpost=ForumPostID][&r=ForumPostID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FORUMPOST (forumpost) | ForumPostID |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/ForumPost?{f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?[f=FolderID][&format=IOType]{&r=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?[f=FolderID][&format=IOType]{&r=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/ForumPost?a=REPLY[&f=FolderID][&format=IOType]{&forumpost=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FORUMPOST (forumpost) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?a=SUBSCRIBE[&f=FolderID][&format=IOType]{&r=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/ForumPost?a=UNSUBSCRIBE[&f=FolderID][&format=IOType]{&r=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/ForumPost?[f=FolderID][&format=IOType][&forumpost=ForumPostID][&r=ForumPostID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FORUMPOST (forumpost) | ForumPostID |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/ForumPost?{f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?[f=FolderID][&format=IOType]{&r=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?[f=FolderID][&format=IOType]{&r=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/ForumPost?a=REPLY[&f=FolderID][&format=IOType]{&forumpost=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FORUMPOST (forumpost) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?a=SUBSCRIBE[&f=FolderID][&format=IOType]{&r=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/ForumPost?a=UNSUBSCRIBE[&f=FolderID][&format=IOType]{&r=ForumPostID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ForumPostID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Guest?[f=FolderID][&format=IOType]{&p=ProjectID}{&role=RoleID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Name": String,
"Password": String,
"Username": String
}
/api/rest/Guest?[f=FolderID][&format=IOType]{&r=UserID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | UserID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Name": String,
"Password": String,
"Username": String
}
/api/rest/CSVHeaders?{file=String}[&f=FolderID][&format=IOType][&r=CSVHeadersID][&sharetoken=ShareTokenID][&tag=String]
FILE (file) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | CSVHeadersID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Language?[f=FolderID][&format=IOType][&r=LanguageID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | LanguageID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/LinkedDocument?[annotation=Annotation2DID][&annotation3d=Annotation3DID][&doc=DocumentID][&f=FolderID][&form=FormID][&format=IOType][&itemkey=ItemID][¬e=NoteID][¬ification=NotificationID][&revision=DocumentRevisionID][&row=Integer][&sharetoken=ShareTokenID][&tag=String][&target=LinkedDocumentDirection][&wfi=WorkflowInstanceID]
ANNOTATION (annotation) | Annotation2DID |
ANNOTATION3D (annotation3d) | Annotation3DID |
DOCUMENT (doc) | DocumentID |
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
NOTE (note) | NoteID |
NOTIFICATION (notification) | NotificationID |
REVISION (revision) | DocumentRevisionID |
ROW (row) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
TARGET (target) | LinkedDocumentDirection |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
/api/rest/LinkedDocument?[f=FolderID][&format=IOType]{&itemkey=ItemID}{&r=DocumentID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
RECORD (r) | DocumentID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/LinkedDocument?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID][&sourcerevision=DocumentRevisionID][&sourcedocument=DocumentID][&targetdocument=DocumentID][&targetrevision=DocumentRevisionID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
SOURCEREVISION (sourcerevision) | DocumentRevisionID |
SOURCEDOCUMENT (sourcedocument) | DocumentID |
TARGETDOCUMENT (targetdocument) | DocumentID |
TARGETREVISION (targetrevision) | DocumentRevisionID |
/api/rest/Log?[f=FolderID][&format=IOType][&limit=Integer][&o=Integer][&ot=Integer][&offset=Integer][&p=ProjectID][&r=LogID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OBJECT_ID (o) | Integer (ID or number) |
OBJECT_TYPE (ot) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | LogID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Log?a=SEARCH[&atype=Integer][&after=String][&before=String][&f=FolderID][&format=IOType][&limit=Integer][&offset=Integer]{&p=ProjectID}[&sharetoken=ShareTokenID][&t=Integer][&u=UserID]
ACTIONTYPE (atype) | Integer (ID or number) |
AFTER (after) | String |
BEFORE (before) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
TYPE (t) | Integer (ID or number) |
USER (u) | UserID |
/api/rest/LogRecent?[f=FolderID][&format=IOType][&limit=Integer][&o=Integer][&ot=Integer][&offset=Integer][&p=ProjectID][&r=LogID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OBJECT_ID (o) | Integer (ID or number) |
OBJECT_TYPE (ot) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | LogID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/LogRecent?a=SEARCH[&atype=Integer][&after=String][&before=String][&f=FolderID][&format=IOType][&limit=Integer][&offset=Integer]{&p=ProjectID}[&sharetoken=ShareTokenID][&t=Integer][&u=UserID]
ACTIONTYPE (atype) | Integer (ID or number) |
AFTER (after) | String |
BEFORE (before) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
TYPE (t) | Integer (ID or number) |
USER (u) | UserID |
/api/rest/LogRoot?[f=FolderID][&format=IOType][&limit=Integer][&o=Integer][&ot=Integer][&offset=Integer][&p=ProjectID][&r=LogID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OBJECT_ID (o) | Integer (ID or number) |
OBJECT_TYPE (ot) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | LogID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/LogRoot?a=SEARCH[&atype=Integer][&after=String][&before=String][&f=FolderID][&format=IOType][&limit=Integer][&offset=Integer]{&p=ProjectID}[&sharetoken=ShareTokenID][&t=Integer][&u=UserID]
ACTIONTYPE (atype) | Integer (ID or number) |
AFTER (after) | String |
BEFORE (before) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
TYPE (t) | Integer (ID or number) |
USER (u) | UserID |
/api/rest/MailList?[f=FolderID][&format=IOType][&p=ProjectID][&r=MailListID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | MailListID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Message?[f=FolderID][&format=IOType][&limit=Integer][&offset=Integer][&p=ProjectID][&r=MessageID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | MessageID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Message?{f=FolderID}[&format=IOType][&ff=MessageID][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FORWARDED_FROM (ff) | MessageID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"AttachmentNames": [String],
"CcID": [Integer],
"BccID": [Integer],
"ToID": [Integer],
"Document": [Integer],
"Subject": String,
"Body": String
}
/api/rest/Message?[f=FolderID][&format=IOType]{&r=MessageID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | MessageID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Message?a=MOVE{&f=FolderID}[&format=IOType]{&r=MessageID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | MessageID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Message?a=PRINT[&f=FolderID][&format=IOType][&p=ProjectID]{&r=MessageID}[&sharetoken=ShareTokenID]{&timezone=TimeZoneID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | MessageID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE (timezone) | TimeZoneID |
/api/rest/Message?a=SEARCH[&after=String][&before=String][&f=FolderID][&format=IOType][&message=String]{&p=ProjectID}[&receiver=String][&sender=String][&sharetoken=ShareTokenID][&subject=String][&t=MessageType]
AFTER (after) | String |
BEFORE (before) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MESSAGE (message) | String |
PROJECT (p) | ProjectID |
RECEIVER (receiver) | String |
SENDER (sender) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
SUBJECT (subject) | String |
TYPE (t) | MessageType |
/api/rest/Message?a=WORKFLOWATTACH[&f=FolderID][&format=IOType]{&r=MessageID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | MessageID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"CoordinatorID": int,
"WorkflowID": int,
"Name": String,
"Description": String,
"Status": EventStatus
}
/api/rest/Message?a=NEW_MAIL[&f=FolderID][&format=IOType]{&p=ProjectID}[&r=MessageID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | MessageID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/RepositoryLink?[f=FolderID][&form=FormID][&format=IOType][&p=ProjectID][&r=RepositoryLinkID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | RepositoryLinkID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/RepositoryLink?[delimiter=String]{&f=FolderID}{&form=FormID}[&format=IOType][&revisions=Boolean][&set default=Boolean][&sharetoken=ShareTokenID][&subfolders=Boolean]
DELIMITER (delimiter) | String |
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
REVISIONS (revisions) | Boolean |
SET_DEFAULT (set default) | Boolean |
SHARETOKEN (sharetoken) | ShareTokenID |
SUBFOLDERS (subfolders) | Boolean |
This call requires a request payload that should look like:
}
/api/rest/RepositoryLink?[delimiter=String]{&f=FolderID}{&form=FormID}[&format=IOType]{&repositorylink=Integer}[&revisions=Boolean][&set default=Boolean][&sharetoken=ShareTokenID][&subfolders=Boolean]
DELIMITER (delimiter) | String |
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
REPOSITORYLINK (repositorylink) | Integer (ID or number) |
REVISIONS (revisions) | Boolean |
SET_DEFAULT (set default) | Boolean |
SHARETOKEN (sharetoken) | ShareTokenID |
SUBFOLDERS (subfolders) | Boolean |
This call requires a request payload that should look like:
}
/api/rest/RepositoryLink?{f=FolderID}{&form=FormID}[&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/RepositoryLink?a=COPY[&f=FolderID][&format=IOType]{&from=FolderID}[&sharetoken=ShareTokenID]{&to=FolderID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FROM (from) | FolderID |
SHARETOKEN (sharetoken) | ShareTokenID |
TO (to) | FolderID |
/api/rest/Note?[f=FolderID][&format=IOType][&o=Integer][&ot=ItemType][&r=NoteID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
OBJECT_ID (o) | Integer (ID or number) |
OBJECT_TYPE (ot) | ItemType |
RECORD (r) | NoteID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Note?[f=FolderID][&format=IOType]{&parent=ItemID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PARENT (parent) | ItemID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/Note?[f=FolderID][&format=IOType]{&r=NoteID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | NoteID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/Note?[f=FolderID][&format=IOType]{&r=NoteID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | NoteID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Notification?[f=FolderID][&format=IOType][&o=Integer][&ot=ItemType][&r=NotificationID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
OBJECT_ID (o) | Integer (ID or number) |
OBJECT_TYPE (ot) | ItemType |
RECORD (r) | NotificationID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Notification?[f=FolderID][&format=IOType]{&o=ItemID}[&p=ProjectID][&sharetoken=ShareTokenID]{&tzstart=String}{&tzend=String}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
OBJECT_ID (o) | ItemID |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE_START (tzstart) | String |
TIMEZONE_END (tzend) | String |
This call requires a request payload that should look like:
}
/api/rest/Notification?a=PRINT[&f=FolderID][&format=IOType][&p=ProjectID]{&r=NotificationID}[&sharetoken=ShareTokenID]{&timezone=TimeZoneID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | NotificationID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE (timezone) | TimeZoneID |
/api/rest/Organization?[admin=String][&f=FolderID][&format=IOType][&p=ProjectID][&r=OrganizationID][&sharetoken=ShareTokenID][&tag=String]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | OrganizationID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Organization?{f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Function": String,
"Name": String,
"State": String,
"Address": String,
"City": String,
"Fax": String,
"Phone": String,
"Zip": String,
"Email": String,
"VAT": String,
"Website": String,
"CountryID": int
}
/api/rest/Organization?{f=FolderID}[&format=IOType]{&r=OrganizationID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | OrganizationID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Function": String,
"Name": String,
"State": String,
"Address": String,
"City": String,
"Fax": String,
"Phone": String,
"Zip": String,
"Email": String,
"VAT": String,
"Website": String,
"CountryID": int
}
/api/rest/Organization?{f=FolderID}[&format=IOType]{&r=OrganizationID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | OrganizationID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Organization?a=MOVE{&f=FolderID}[&format=IOType]{&from=FolderID}{&r=OrganizationID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FROM (from) | FolderID |
RECORD (r) | OrganizationID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Organization?a=COPY{&f=FolderID}[&format=IOType]{&from=FolderID}{&r=OrganizationID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
FROM (from) | FolderID |
RECORD (r) | OrganizationID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Organization?a=PRINT{&f=FolderID}[&format=IOType][&p=ProjectID][&r=OrganizationID][&sharetoken=ShareTokenID]{&timezone=TimeZoneID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | OrganizationID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE (timezone) | TimeZoneID |
/api/rest/Organization?a=IMPORT{&f=FolderID}[&format=IOType][&members=Boolean]{&p=ProjectID}{&r=OrganizationID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MEMBERS (members) | Boolean |
PROJECT (p) | ProjectID |
RECORD (r) | OrganizationID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Organization?a=SEARCH[&f=FolderID][&format=IOType]{&s=String}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SEARCH (s) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Organization?a=DOWNLOAD{&f=FolderID}[&format=IOType]{&r=OrganizationID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | OrganizationID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?[active=Boolean][&admin=Boolean][&allcustomers=Boolean][&customer=CustomerID][&customerids=Integer][&filter=ProjectType][&f=FolderID][&format=IOType][&r=ProjectID][&sharetoken=ShareTokenID][&size=Boolean][&tag=String][&u=UserID][&wfi=WorkflowInstanceID][&workflow=WorkflowID]
ACTIVE (active) | Boolean |
ADMIN (admin) | Boolean |
ALL_CUSTOMERS (allcustomers) | Boolean |
CUSTOMER (customer) | CustomerID |
CUSTOMER_IDS (customerids) | Integer (ID or number) |
FILTER (filter) | ProjectType |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
SIZE (size) | Boolean |
TAG (tag) | String |
USER (u) | UserID |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
WORKFLOW (workflow) | WorkflowID |
/api/rest/Project?[addressbook data=Boolean][&admin_folder_subscriptions=Boolean][&autoworkflows=Boolean][&binder settings=Boolean][&binder content=Boolean][&country=Integer]{&customer=CustomerID}[&description=String][&document status list=Boolean][&f=FolderID][&folders=Boolean][&forms=Boolean][&format=IOType][&logoname=FileID][&metadata=Boolean]{&name=String}[&roles=Boolean][&sharetoken=ShareTokenID][&template=Integer][&users=Boolean][&webhooks=Boolean][&workflows=Boolean]
ADDRESSBOOK_DATA (addressbook data) | Boolean |
ADMIN_FOLDER_SUBSCRIPTIONS (admin_folder_subscriptions) | Boolean |
AUTOWORKFLOWS (autoworkflows) | Boolean |
BINDER_SETTINGS (binder settings) | Boolean |
BINDER_CONTENT (binder content) | Boolean |
COUNTRY (country) | Integer (ID or number) |
CUSTOMER (customer) | CustomerID |
DESCRIPTION (description) | String |
DOCUMENT_STATUS_LIST (document status list) | Boolean |
FOLDER (f) | FolderID |
FOLDERS (folders) | Boolean |
FORMS (forms) | Boolean |
FORMAT (format) | IOType |
LOGONAME (logoname) | FileID |
METADATA (metadata) | Boolean |
NAME (name) | String |
ROLES (roles) | Boolean |
SHARETOKEN (sharetoken) | ShareTokenID |
TEMPLATE (template) | Integer (ID or number) |
USERS (users) | Boolean |
WEBHOOKS (webhooks) | Boolean |
WORKFLOWS (workflows) | Boolean |
/api/rest/Project?[f=FolderID][&format=IOType][&limit=Integer]{&r=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Name": String,
"FirstDayOfWeek": int,
"Address": String,
"Flags":
{
"ReplaceDocumentRevisions": boolean,
"LockPastEvents": boolean,
"MultiFactor": Boolean,
"LockedRecycleBin": boolean,
"DeleteRevisions": boolean,
"DisplaySignature": boolean,
"AdminCanViewMessages": boolean,
"CanLockDocuments": boolean,
"MultiFactor": boolean,
"DescriptionInNameForDownload": boolean,
"MajorMinorVersionEnabled": boolean,
"VueInterfaceAsDefault": boolean
},
"City": String,
"Zip": String,
"Details": String,
"RevisionCounterType": int,
"MajorRevisionCounterType": int,
"WeekendDays":
{
"Monday": boolean,
"Tuesday": boolean,
"Wednesday": boolean,
"Thursday": boolean,
"Friday": boolean,
"Saturday": boolean,
"Sunday": boolean
},
"CountryID": int
}
/api/rest/Project?[f=FolderID][&format=IOType]{&r=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=UNDELETE[&f=FolderID][&format=IOType]{&r=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=DELETEHARD[&f=FolderID][&format=IOType]{&r=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=ACTIVATE[&f=FolderID][&format=IOType]{&r=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=DEACTIVATE[&f=FolderID][&format=IOType]{&r=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=PREVIEW[&default value=Boolean][&f=FolderID][&format=IOType]{&r=ProjectID}[&sharetoken=ShareTokenID]
DEFAULT_VALUE (default value) | Boolean |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=SET_DEFAULT_STATUS[&f=FolderID][&format=IOType]{&r=ProjectID}[&sharetoken=ShareTokenID][&status=DocumentStatusID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
STATUS (status) | DocumentStatusID |
/api/rest/Project?a=CHANGE_IMAGE[&f=FolderID][&format=IOType][&image=FileID]{&r=ProjectID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
IMAGE (image) | FileID |
RECORD (r) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/RepositoryQuery?[f=FolderID][&format=IOType][&p=ProjectID][&r=RepositoryQueryID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | RepositoryQueryID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/RepositoryQuery?a=RUN[&f=FolderID][&format=IOType]{&r=RepositoryQueryID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | RepositoryQueryID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Parameters": [String]
}
/api/rest/RecycleBin?[folders=Boolean][&format=IOType][&limit=Integer][&offset=Integer]{&p=ProjectID}[&sharetoken=ShareTokenID][&tag=String][&t=ItemType]
FOLDERS (folders) | Boolean |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
TYPE (t) | ItemType |
/api/rest/RecycleBin?[f=FolderID][&format=IOType]{&itemkey=ItemID}[&limit=Integer][&sharetoken=ShareTokenID][&simulate=String][&withitems=Boolean]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
LIMIT (limit) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
SIMULATE (simulate) | String |
WITH_ITEMS (withitems) | Boolean |
/api/rest/RecycleBin?a=UNDELETE[&f=FolderID][&format=IOType]{&itemkey=String}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/RepositoryTable?[admin=String][&f=FolderID][&form=FormID][&format=IOType][&p=ProjectID][&r=RepositoryTableID][&sharetoken=ShareTokenID][&tag=String]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORM (form) | FormID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | RepositoryTableID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/RepositoryTable?[f=FolderID][&format=IOType]{&r=RepositoryTableID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | RepositoryTableID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Table":
{
"Form": int,
"Role": int,
"Table": int,
"CanView": boolean,
"CanAdd": boolean,
"CanEdit": boolean,
"CanDelete": boolean
},
"Columns": [
{
"Role": int,
"FormField": int,
"Column": int,
"CanView": boolean,
"CanAdd": boolean,
"CanEdit": boolean
}
],
"ObjectType": ItemType
}
/api/rest/RepositoryTable?a=IMPORTCSV[&document_header_index=Integer]{&file=String}[&f=FolderID][&format=IOType]{&mapping=String}{&r=RepositoryTableID}[&revision_header_index=Integer][&sharetoken=ShareTokenID]
DOCUMENT_HEADER_INDEX (document_header_index) | Integer (ID or number) |
FILE (file) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MAPPING (mapping) | String |
RECORD (r) | RepositoryTableID |
REVISION_HEADER_INDEX (revision_header_index) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Role?[admin=String][&f=FolderID][&format=IOType][&p=ProjectID][&r=RoleID][&s=String][&sharetoken=ShareTokenID][&tag=String]
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | RoleID |
SEARCH (s) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Role?[cpaccess=RoleID][&cpmembers=RoleID][&f=FolderID][&format=IOType][&import=Boolean]{&p=ProjectID}[&role=RoleID][&sharetoken=ShareTokenID]
COPY_ACCESS (cpaccess) | RoleID |
COPY_MEMBERS (cpmembers) | RoleID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
IMPORT (import) | Boolean |
PROJECT (p) | ProjectID |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"IsGuestRole": boolean,
"TodoAdmin": boolean,
"Users": [Integer],
"ColorHex": String,
"Name": String,
"Color": int,
"CanViewReports": boolean,
"CanEditProfile": boolean,
"CanSeeOtherUsers": boolean,
"CanViewDocumentRevisions": boolean,
"IsMailList": boolean
}
/api/rest/Role?[f=FolderID][&format=IOType]{&r=RoleID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"IsGuestRole": boolean,
"TodoAdmin": boolean,
"Users": [Integer],
"ColorHex": String,
"Name": String,
"Color": int,
"CanViewReports": boolean,
"CanEditProfile": boolean,
"CanSeeOtherUsers": boolean,
"CanViewDocumentRevisions": boolean,
"IsMailList": boolean
}
/api/rest/Role?[f=FolderID][&format=IOType]{&r=RoleID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/RoleMember?[f=FolderID][&format=IOType][&p=ProjectID][&r=RoleMemberID][&role=RoleID][&sharetoken=ShareTokenID][&tag=String][&u=UserID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | RoleMemberID |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
USER (u) | UserID |
/api/rest/RoleMember?{contact=ContactID}[&f=FolderID][&format=IOType][&organization=OrganizationID]{&role=RoleID}[&sharetoken=ShareTokenID]
CONTACT (contact) | ContactID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ORGANIZATION (organization) | OrganizationID |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/RoleMember?[f=FolderID][&format=IOType]{&p=ProjectID}[&role=RoleID][&sharetoken=ShareTokenID]{&u=UserID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
USER (u) | UserID |
/api/rest/Search?[f=FolderID][&format=IOType]{&p=ProjectID}{&s=String}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
SEARCH (s) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/BimStory?{building=Integer}[&f=FolderID][&format=IOType]{&model=Integer}[&modelversion=String][&r=BimStoryID][&sharetoken=ShareTokenID][&tag=String]
BUILDING (building) | Integer (ID or number) |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
MODEL (model) | Integer (ID or number) |
MODEL_VERSION (modelversion) | String |
RECORD (r) | BimStoryID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Tag?[customer=CustomerID][&f=FolderID][&format=IOType][&itemkey=ItemID][&r=TagID][&sharetoken=ShareTokenID][&tag=String]
CUSTOMER (customer) | CustomerID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
RECORD (r) | TagID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Tag?[f=FolderID][&format=IOType]{&itemkey=ItemID}[&sharetoken=ShareTokenID]{&tag=String}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/Tag?[f=FolderID][&format=IOType]{&itemkey=ItemID}{&r=TagID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | ItemID |
RECORD (r) | TagID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Task?[active=Boolean][&end=String][&f=FolderID][&format=IOType][&limit=Integer][&offset=Integer][&p=ProjectID][&r=TaskID][&sharetoken=ShareTokenID][&start=String][&tag=String][&t=TaskCategory]
ACTIVE (active) | Boolean |
END (end) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | TaskID |
SHARETOKEN (sharetoken) | ShareTokenID |
START (start) | String |
TAG (tag) | String |
TYPE (t) | TaskCategory |
/api/rest/ActivityInstance?[activity=ActivityID][&f=FolderID][&format=IOType][&sharetoken=ShareTokenID][&wfi=WorkflowInstanceID][&wfi_state=WorkflowInstanceStateID]
ACTIVITY (activity) | ActivityID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
WORKFLOW_INSTANCE_STATE (wfi_state) | WorkflowInstanceStateID |
/api/rest/ActivityInstance?a=SETACTOR{&activity=ActivityID}[&actor=Integer][&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&wfi=WorkflowInstanceID}
ACTIVITY (activity) | ActivityID |
ACTOR (actor) | Integer (ID or number) |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
/api/rest/ActivityInstance?a=SETSTATE{&activity=ActivityID}[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&wfi=WorkflowInstanceID}
ACTIVITY (activity) | ActivityID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
This call requires a request payload that should look like:
{
"StateID": int,
"CommentAsNote": boolean,
"ObjectID": int,
"LinkToDocumentIDs": [Integer],
"SkipJob": boolean,
"Comment": String
}
/api/rest/Url?[f=FolderID][&format=IOType][&r=Integer][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Url?{f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/Url?[f=FolderID][&format=IOType]{&r=UrlID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | UrlID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/Url?[f=FolderID][&format=IOType]{&r=UrlID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | UrlID |
SHARETOKEN (sharetoken) | ShareTokenID |
pssssst don't delete me please :(
/api/rest/User?[activity=ActivityID][&actor=UserID][&admin=String][&customer=Boolean][&f=FolderID][&format=IOType][&itemkey=String][&p=ProjectID][&r=UserID][&role=RoleID][&sharetoken=ShareTokenID][&tag=String][&u=UserID][&wfi=WorkflowInstanceID][&workflow=WorkflowID]
ACTIVITY (activity) | ActivityID |
ACTOR (actor) | UserID |
ADMIN (admin) | String |
CUSTOMER (customer) | Boolean |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
ITEMKEY (itemkey) | String |
PROJECT (p) | ProjectID |
RECORD (r) | UserID |
ROLE (role) | RoleID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
USER (u) | UserID |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
WORKFLOW (workflow) | WorkflowID |
/api/rest/User?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"Password": String,
"UseEmailAsUsername": boolean,
"Name": String,
"Username": String,
"VueInterfacePreferred": boolean,
"HourOfDailyOverview": int,
"HourOfDailyTaskOverview": int,
"StopTaskNotifications": boolean,
"RevisionInNameForDownload": boolean,
"Email": String,
"Language": int,
"State": String,
"Address": String,
"City": String,
"Fax": String,
"Mobile": String,
"Phone": String,
"Zip": String,
"FirstName": String,
"LastName": String,
"CountryID": int
}
/api/rest/User?[f=FolderID][&format=IOType]{&p=ProjectID}{&r=UserID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | UserID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/User?a=SEARCH[&email=String][&f=FolderID][&format=IOType][&p=ProjectID][&sharetoken=ShareTokenID]
EMAIL (email) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/User?a=SETACTOR{&actor=UserID}[&f=FolderID][&format=IOType]{&p=ProjectID}{&r=UserID}[&sharetoken=ShareTokenID]
ACTOR (actor) | UserID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | UserID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/User?a=CONFIRM[&f=FolderID][&format=IOType][&password=String][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PASSWORD (password) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/User?a=CHANGE_IMAGE[&f=FolderID][&format=IOType][&image=FileID][&r=UserID][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
IMAGE (image) | FileID |
RECORD (r) | UserID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/User?a=VIEW_HELP{&category=String}[&f=FolderID][&format=IOType]{&seq=Integer}[&sharetoken=ShareTokenID]
CATEGORY (category) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SEQUENCE (seq) | Integer (ID or number) |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/User?a=TOKEN_AUTHENTICATE[&f=FolderID][&format=IOType]{&token=String}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
TOKEN (token) | String |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/UserAccessToken?[f=FolderID][&format=IOType][&r=UserAccessTokenID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | UserAccessTokenID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |
/api/rest/UserAccessToken?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/UserAccessToken?[f=FolderID][&format=IOType]{&r=UserAccessTokenID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | UserAccessTokenID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/WorkflowInstance?[end=String][&f=FolderID][&format=IOType][&limit=Integer][&o=Integer][&ot=ItemType][&offset=Integer][&p=ProjectID][&r=WorkflowInstanceID][&sharetoken=ShareTokenID][&start=String][&status=String][&tag=String]
END (end) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
LIMIT (limit) | Integer (ID or number) |
OBJECT_ID (o) | Integer (ID or number) |
OBJECT_TYPE (ot) | ItemType |
OFFSET (offset) | Integer (ID or number) |
PROJECT (p) | ProjectID |
RECORD (r) | WorkflowInstanceID |
SHARETOKEN (sharetoken) | ShareTokenID |
START (start) | String |
STATUS (status) | String |
TAG (tag) | String |
/api/rest/WorkflowInstance?[f=FolderID][&format=IOType]{&r=WorkflowInstanceID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | WorkflowInstanceID |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"WorkflowInstanceStatus": WorkflowInstanceStatus,
"Name": String,
"Description": String,
"Status": EventStatus
}
/api/rest/WorkflowInstance?a=PRINT[&f=FolderID][&format=IOType][&p=ProjectID]{&r=WorkflowInstanceID}[&sharetoken=ShareTokenID]{&timezone=TimeZoneID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
PROJECT (p) | ProjectID |
RECORD (r) | WorkflowInstanceID |
SHARETOKEN (sharetoken) | ShareTokenID |
TIMEZONE (timezone) | TimeZoneID |
/api/rest/WorkflowInstance?a=CANCEL[&f=FolderID][&format=IOType]{&r=WorkflowInstanceID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | WorkflowInstanceID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/WorkflowInstance?a=PREVIEW[&f=FolderID][&format=IOType]{&r=WorkflowInstanceID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | WorkflowInstanceID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/WorkflowInstanceState?[doc=DocumentID][&f=FolderID][&format=IOType][&r=WorkflowInstanceStateID][&sharetoken=ShareTokenID][&wfi=WorkflowInstanceID]
DOCUMENT (doc) | DocumentID |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | WorkflowInstanceStateID |
SHARETOKEN (sharetoken) | ShareTokenID |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
/api/rest/WorkflowInstanceState?a=SETACTOR[&f=FolderID][&format=IOType]{&r=WorkflowInstanceStateID}[&sharetoken=ShareTokenID]{&u=UserID}
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | WorkflowInstanceStateID |
SHARETOKEN (sharetoken) | ShareTokenID |
USER (u) | UserID |
/api/rest/Workflow?[activewftasks=Boolean][&admin=String][&f=FolderID][&format=IOType][&ot=ItemType][&p=ProjectID][&r=WorkflowID][&sharetoken=ShareTokenID][&status=WorkflowStatus][&tag=String][&wfi=WorkflowInstanceID]
ACTIVE_WORKFLOW_TASKS (activewftasks) | Boolean |
ADMIN (admin) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
OBJECT_TYPE (ot) | ItemType |
PROJECT (p) | ProjectID |
RECORD (r) | WorkflowID |
SHARETOKEN (sharetoken) | ShareTokenID |
STATUS (status) | WorkflowStatus |
TAG (tag) | String |
WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
/api/rest/Workflow?{f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"CoordinatorID": int,
"Name": String,
"Description": String,
"Coordinator":
}
}
/api/rest/Workflow?[f=FolderID][&format=IOType]{&r=WorkflowID}[&sharetoken=ShareTokenID][&viewer=Boolean]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | WorkflowID |
SHARETOKEN (sharetoken) | ShareTokenID |
VIEWER (viewer) | Boolean |
This call requires a request payload that should look like:
{
"Status": WorkflowStatus,
"CoordinatorID": int,
"Name": String,
"Description": String,
"Coordinator":
}
}
/api/rest/Workflow?[f=FolderID][&format=IOType]{&r=WorkflowID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | WorkflowID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Workflow?a=MOVE[&description=String]{&f=FolderID}[&format=IOType][&name=String]{&r=WorkflowID}[&sharetoken=ShareTokenID]
DESCRIPTION (description) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
NAME (name) | String |
RECORD (r) | WorkflowID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Workflow?a=COPY[&coordinator=RoleID][&description=String]{&f=FolderID}[&format=IOType]{&name=String}{&r=WorkflowID}[&sharetoken=ShareTokenID]
COORDINATOR (coordinator) | RoleID |
DESCRIPTION (description) | String |
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
NAME (name) | String |
RECORD (r) | WorkflowID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Workflow?a=RELEASE[&f=FolderID][&format=IOType]{&r=WorkflowID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | WorkflowID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Workflow?a=PREVIEW[&f=FolderID][&format=IOType]{&r=WorkflowID}[&sharetoken=ShareTokenID]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | WorkflowID |
SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Xref?[f=FolderID][&format=IOType][&r=XrefID][&revision=DocumentRevisionID][&sharetoken=ShareTokenID][&tag=String]
FOLDER (f) | FolderID |
FORMAT (format) | IOType |
RECORD (r) | XrefID |
REVISION (revision) | DocumentRevisionID |
SHARETOKEN (sharetoken) | ShareTokenID |
TAG (tag) | String |