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 |
| {} | 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.
Eg. 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?[tag=String][&r=DocumentRevisionID][&p=ProjectID][&revision=Integer][&format=IOType][&doc=DocumentID][&offset=Integer][&f=FolderID][&limit=Integer][&sharetoken=ShareTokenID]
| TAG (tag) | String |
| RECORD (r) | DocumentRevisionID |
| PROJECT (p) | ProjectID |
| REVISION (revision) | Integer (ID or number) |
| FORMAT (format) | IOType |
| DOCUMENT (doc) | DocumentID |
| OFFSET (offset) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| LIMIT (limit) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/DocumentRevision?{r=DocumentRevisionID}[&sharetoken=ShareTokenID][&f=FolderID][&format=IOType]
| RECORD (r) | DocumentRevisionID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/DocumentRevision?a=PRINT{&timezone=TimeZoneID}[&f=FolderID]{&r=DocumentRevisionID}[&format=IOType][&sharetoken=ShareTokenID][&p=ProjectID]
| TIMEZONE (timezone) | TimeZoneID |
| FOLDER (f) | FolderID |
| RECORD (r) | DocumentRevisionID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
/api/rest/DocumentRevision?a=DOWNLOAD[&format=IOType]{&r=DocumentRevisionID}[&f=FolderID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| RECORD (r) | DocumentRevisionID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/DocumentRevision?a=QRCODE[&format=IOType][&sharetoken=ShareTokenID][&size=Integer]{&r=DocumentRevisionID}[&atype=String][&f=FolderID]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| SIZE (size) | Integer (ID or number) |
| RECORD (r) | DocumentRevisionID |
| ACTIONTYPE (atype) | String |
| FOLDER (f) | FolderID |
/api/rest/ActivityTask?[sharetoken=ShareTokenID][&format=IOType][&activity=ActivityID][&wfi_state=WorkflowInstanceStateID][&wfi=WorkflowInstanceID][&f=FolderID]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| ACTIVITY (activity) | ActivityID |
| WORKFLOW_INSTANCE_STATE (wfi_state) | WorkflowInstanceStateID |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| FOLDER (f) | FolderID |
/api/rest/ActivityTask?a=SETACTOR[&sharetoken=ShareTokenID][&actor=Integer]{&wfi=WorkflowInstanceID}[&f=FolderID][&format=IOType]{&activity=ActivityID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| ACTOR (actor) | Integer (ID or number) |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| ACTIVITY (activity) | ActivityID |
/api/rest/ActivityTask?a=SETSTATE{&activity=ActivityID}[&f=FolderID][&format=IOType]{&wfi=WorkflowInstanceID}[&sharetoken=ShareTokenID]
| ACTIVITY (activity) | ActivityID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("StateID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CommentAsNote"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LinkToDocumentIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("SkipJob"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Comment"": String
}
/api/rest/AdminAccess?{p=ProjectID}[&sharetoken=ShareTokenID][&format=IOType][&f=FolderID]
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
/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:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Contact"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageProjectSettings"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageUserRoles"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageFolderStructure"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageFolderAccess"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageTableAccess"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageExternalAppAccess"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageAuditReport"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageRecycleBin"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageAdministrators"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Project"": int
}
/api/rest/AdminAccess?[format=IOType][&sharetoken=ShareTokenID][&f=FolderID]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AdminAccess"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Contact"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageProjectSettings"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageUserRoles"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageFolderStructure"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageFolderAccess"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageTableAccess"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageExternalAppAccess"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageAuditReport"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageRecycleBin"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanManageAdministrators"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Project"": int
}
]
}
/api/rest/Annotation2D?[r=Annotation2DID][&revision=DocumentRevisionID][&f=FolderID][&format=IOType][&sharetoken=ShareTokenID][&tag=String][&dv=DocumentViewID][&pg=Integer]
| RECORD (r) | Annotation2DID |
| REVISION (revision) | DocumentRevisionID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| TAG (tag) | String |
| DOCUMENT_VIEW (dv) | DocumentViewID |
| PAGE (pg) | Integer (ID or number) |
/api/rest/Annotation2D?[format=IOType][&f=FolderID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("RegionW"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("RegionH"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DocumentView"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ToID"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("RegionY"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("RegionX"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Shape"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Page"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Subject"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Body"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Public"": boolean
}
/api/rest/Annotation3D?[tag=String][&revision=DocumentRevisionID][&sharetoken=ShareTokenID][&f=FolderID][&r=Annotation3DID][&format=IOType]
| TAG (tag) | String |
| REVISION (revision) | DocumentRevisionID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | Annotation3DID |
| FORMAT (format) | IOType |
/api/rest/Annotation3D?[sharetoken=ShareTokenID][&f=FolderID][&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ToID"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AnchorX"": double,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AnchorY"": double,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AnchorZ"": double,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LeaderX"": double,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LeaderY"": double,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LeaderZ"": double,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectID"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Revision"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Subject"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Body"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Public"": boolean
}
/api/rest/App?a=RUN[&format=IOType][&sharetoken=ShareTokenID]{&itemkey=ItemID}{&app=AppID}[&f=FolderID]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| ITEMKEY (itemkey) | ItemID |
| APP (app) | AppID |
| FOLDER (f) | FolderID |
/api/rest/AppVisibility?[tag=String][&sharetoken=ShareTokenID][&f=FolderID][&r=AppVisibilityID][&format=IOType]{&role=RoleID}
| TAG (tag) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | AppVisibilityID |
| FORMAT (format) | IOType |
| ROLE (role) | RoleID |
/api/rest/FolderAproPlan?[p=ProjectID][&r=FolderAproPlanID][&format=IOType][&sharetoken=ShareTokenID][&f=FolderID][&tag=String]
| PROJECT (p) | ProjectID |
| RECORD (r) | FolderAproPlanID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| TAG (tag) | String |
/api/rest/FolderAproPlan?{aproplanfolder=String}{&alias=String}[&sharetoken=ShareTokenID]{&password=String}[&format=IOType]{&aproplanproject=String}{&f=FolderID}
| APROPLAN_FOLDER (aproplanfolder) | String |
| ALIAS (alias) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PASSWORD (password) | String |
| FORMAT (format) | IOType |
| APROPLAN_PROJECT (aproplanproject) | String |
| FOLDER (f) | FolderID |
/api/rest/FolderAproPlan?[format=IOType][&sharetoken=ShareTokenID]{&r=FolderAproPlanID}[&f=FolderID]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | FolderAproPlanID |
| FOLDER (f) | FolderID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Password"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Username"": String
}
/api/rest/FolderAproPlan?{r=FolderAproPlanID}[&format=IOType][&f=FolderID][&sharetoken=ShareTokenID]
| RECORD (r) | FolderAproPlanID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/AproPlanFolder?[sharetoken=ShareTokenID]{&alias=String}[&r=AproPlanFolderID][&aproplanproject=String][&tag=String][&f=FolderID][&parent=String][&format=IOType]{&password=String}
| SHARETOKEN (sharetoken) | ShareTokenID |
| ALIAS (alias) | String |
| RECORD (r) | AproPlanFolderID |
| APROPLAN_PROJECT (aproplanproject) | String |
| TAG (tag) | String |
| FOLDER (f) | FolderID |
| PARENT (parent) | String |
| FORMAT (format) | IOType |
| PASSWORD (password) | String |
/api/rest/AproPlanProject?[sharetoken=ShareTokenID]{&alias=String}[&r=AproPlanProjectID]{&password=String}[&format=IOType][&f=FolderID][&tag=String]
| SHARETOKEN (sharetoken) | ShareTokenID |
| ALIAS (alias) | String |
| RECORD (r) | AproPlanProjectID |
| PASSWORD (password) | String |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| TAG (tag) | String |
/api/rest/AproPlanSyncQueue?[r=AproPlanSyncQueueID][&format=IOType]{&f=FolderID}[&sharetoken=ShareTokenID][&tag=String]
| RECORD (r) | AproPlanSyncQueueID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| TAG (tag) | String |
/api/rest/AproPlanUser?a=LOGIN_SECURE[&sharetoken=ShareTokenID][&format=IOType][&f=FolderID]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Password"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Username"": String
}
/api/rest/Attachment?[f=FolderID]{&itemkey=String}[&format=IOType][&name=String][&tag=String][&sharetoken=ShareTokenID][&r=AttachmentID][&p=ProjectID]
| FOLDER (f) | FolderID |
| ITEMKEY (itemkey) | String |
| FORMAT (format) | IOType |
| NAME (name) | String |
| TAG (tag) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | AttachmentID |
| PROJECT (p) | ProjectID |
/api/rest/Attachment?[sharetoken=ShareTokenID][&f=FolderID][&format=IOType]{&itemkey=ItemID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| ITEMKEY (itemkey) | ItemID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Items"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FileName"": String
}
]
}
/api/rest/Attachment?[format=IOType][&itemkey=ItemID][&f=FolderID]{&r=AttachmentID}[&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| ITEMKEY (itemkey) | ItemID |
| FOLDER (f) | FolderID |
| RECORD (r) | AttachmentID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Attachment?a=DOWNLOAD[&sharetoken=ShareTokenID][&itemkey=String]{&r=AttachmentID}[&format=IOType][&f=FolderID]
| SHARETOKEN (sharetoken) | ShareTokenID |
| ITEMKEY (itemkey) | String |
| RECORD (r) | AttachmentID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
/api/rest/Attachment?a=PREVIEW[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID][&pg=Integer][&dv=Integer]{&r=AttachmentID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| PAGE (pg) | Integer (ID or number) |
| DOCUMENT_VIEW (dv) | Integer (ID or number) |
| RECORD (r) | AttachmentID |
/api/rest/AutoWorkflow?[format=IOType][&tag=String][&admin=String][&f=FolderID][&sharetoken=ShareTokenID][&r=AutoWorkflowID]{&p=ProjectID}
| FORMAT (format) | IOType |
| TAG (tag) | String |
| ADMIN (admin) | String |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | AutoWorkflowID |
| PROJECT (p) | ProjectID |
/api/rest/AutoWorkflow?{workflow=WorkflowID}{&revision=Boolean}{&f=FolderID}[&coordinator=Integer][&sharetoken=ShareTokenID][&subfolders=Boolean][&cancelprefwf=Boolean][&format=IOType]
| WORKFLOW (workflow) | WorkflowID |
| REVISION (revision) | Boolean |
| FOLDER (f) | FolderID |
| COORDINATOR (coordinator) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| SUBFOLDERS (subfolders) | Boolean |
| CANCEL_PREV_WF (cancelprefwf) | Boolean |
| FORMAT (format) | IOType |
/api/rest/AutoWorkflow?{f=FolderID}[&format=IOType][&cancelprefwf=Boolean]{&autoworkflow=AutoWorkflowID}[&coordinator=Integer][&sharetoken=ShareTokenID]{&workflow=WorkflowID}[&subfolders=Boolean]{&revision=Boolean}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| CANCEL_PREV_WF (cancelprefwf) | Boolean |
| AUTOWORKFLOW (autoworkflow) | AutoWorkflowID |
| COORDINATOR (coordinator) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| WORKFLOW (workflow) | WorkflowID |
| SUBFOLDERS (subfolders) | Boolean |
| REVISION (revision) | Boolean |
/api/rest/AutoWorkflow?[format=IOType][&subfolders=Boolean][&f=FolderID][&sharetoken=ShareTokenID]{&r=AutoWorkflowID}
| FORMAT (format) | IOType |
| SUBFOLDERS (subfolders) | Boolean |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | AutoWorkflowID |
/api/rest/AutoWorkflow?a=COPY{&from=FolderID}[&f=FolderID][&sharetoken=ShareTokenID][&format=IOType]{&to=FolderID}
| FROM (from) | FolderID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| TO (to) | FolderID |
/api/rest/Bim?[r=BimID]{&model=Integer}[&parenttype=String][&parentidentifier=String][&tag=String][&bimrecord=Integer][&story=Integer][&format=IOType][&recursive=Boolean][&sharetoken=ShareTokenID][&building=Integer]{&f=FolderID}[&modelversion=String]
| RECORD (r) | BimID |
| MODEL (model) | Integer (ID or number) |
| PARENT_TYPE (parenttype) | String |
| PARENT_IDENTIFIER (parentidentifier) | String |
| TAG (tag) | String |
| BIM_RECORD (bimrecord) | Integer (ID or number) |
| STORY (story) | Integer (ID or number) |
| FORMAT (format) | IOType |
| RECURSIVE (recursive) | Boolean |
| SHARETOKEN (sharetoken) | ShareTokenID |
| BUILDING (building) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| MODEL_VERSION (modelversion) | String |
/api/rest/BinderItem?{f=FolderID}[&tag=String][&r=ItemID][&format=IOType][&limit=Integer][&sharetoken=ShareTokenID][&offset=Integer]
| FOLDER (f) | FolderID |
| TAG (tag) | String |
| RECORD (r) | ItemID |
| FORMAT (format) | IOType |
| LIMIT (limit) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| OFFSET (offset) | Integer (ID or number) |
/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[&sharetoken=ShareTokenID]{&f=FolderID}[&format=IOType]{&itemkey=ItemID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| ITEMKEY (itemkey) | ItemID |
/api/rest/BimBuilding?[modelversion=String]{&model=Integer}[&f=FolderID][&r=BimBuildingID][&sharetoken=ShareTokenID][&format=IOType][&tag=String]
| MODEL_VERSION (modelversion) | String |
| MODEL (model) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| RECORD (r) | BimBuildingID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| TAG (tag) | String |
/api/rest/Contact?[tag=String][&sharetoken=ShareTokenID][&r=ContactID][&limit=Integer][&f=FolderID][&format=IOType][&offset=Integer][&admin=Boolean][&p=ProjectID]
| TAG (tag) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | ContactID |
| LIMIT (limit) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| OFFSET (offset) | Integer (ID or number) |
| ADMIN (admin) | Boolean |
| PROJECT (p) | ProjectID |
/api/rest/Contact?[f=FolderID][&image=FileID][&sharetoken=ShareTokenID][&format=IOType][&p=ProjectID]
| FOLDER (f) | FolderID |
| IMAGE (image) | FileID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| PROJECT (p) | ProjectID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Function"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("OrganizationsID"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("State"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Address"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Email"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FirstName"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LastName"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("City"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Fax"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Mobile"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Phone"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Zip"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CountryID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Language"": int
}
/api/rest/Contact?[p=ProjectID][&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&r=ContactID}
| PROJECT (p) | ProjectID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | ContactID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Function"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("OrganizationsID"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("State"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Address"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Email"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FirstName"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LastName"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("City"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Fax"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Mobile"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Phone"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Zip"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CountryID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Language"": int
}
/api/rest/Contact?[sharetoken=ShareTokenID]{&f=FolderID}[&format=IOType]{&r=ContactID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| RECORD (r) | ContactID |
/api/rest/Contact?a=MOVE{&f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]{&from=FolderID}{&r=ContactID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FROM (from) | FolderID |
| RECORD (r) | ContactID |
/api/rest/Contact?a=COPY[&sharetoken=ShareTokenID]{&from=FolderID}{&r=ContactID}[&format=IOType]{&f=FolderID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FROM (from) | FolderID |
| RECORD (r) | ContactID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
/api/rest/Contact?a=PRINT[&p=ProjectID][&r=ContactID]{&f=FolderID}[&format=IOType]{&timezone=TimeZoneID}[&sharetoken=ShareTokenID]
| PROJECT (p) | ProjectID |
| RECORD (r) | ContactID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| TIMEZONE (timezone) | TimeZoneID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=IMPORT{&r=ContactID}[&sharetoken=ShareTokenID][&format=IOType]{&f=FolderID}
| RECORD (r) | ContactID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
/api/rest/Contact?a=SEARCH[&f=FolderID][&format=IOType][&all=Boolean]{&s=String}[&sharetoken=ShareTokenID][&byusername=Boolean][&root=Boolean][&p=ProjectID]
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| ALL (all) | Boolean |
| SEARCH (s) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| BY_USERNAME (byusername) | Boolean |
| ROOT (root) | Boolean |
| PROJECT (p) | ProjectID |
/api/rest/Contact?a=DOWNLOAD{&r=ContactID}{&f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]
| RECORD (r) | ContactID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Contact?a=PREVIEW[&f=FolderID]{&r=ContactID}[&sharetoken=ShareTokenID][&format=IOType][&default value=Boolean]
| FOLDER (f) | FolderID |
| RECORD (r) | ContactID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| DEFAULT_VALUE (default value) | Boolean |
/api/rest/Contact?a=MERGE{&r=ContactID}[&format=IOType]{&password=String}[&f=FolderID][&sharetoken=ShareTokenID]{&u=String}
| RECORD (r) | ContactID |
| FORMAT (format) | IOType |
| PASSWORD (password) | String |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| USER (u) | String |
/api/rest/Contact?a=IMPORTCSV{&file=String}{&mapping=String}[&r=ContactID]{&f=FolderID}[&sharetoken=ShareTokenID][&format=IOType]
| FILE (file) | String |
| MAPPING (mapping) | String |
| RECORD (r) | ContactID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
/api/rest/Contact?a=NEW_MAIL[&sharetoken=ShareTokenID][&format=IOType][&resend=Boolean][&f=FolderID]{&r=ContactID}{&p=ProjectID}[&message=String]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| RESEND (resend) | Boolean |
| FOLDER (f) | FolderID |
| RECORD (r) | ContactID |
| PROJECT (p) | ProjectID |
| MESSAGE (message) | String |
/api/rest/Contact?a=CHANGE_IMAGE[&sharetoken=ShareTokenID]{&f=FolderID}{&r=ContactID}[&format=IOType][&image=FileID]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | ContactID |
| FORMAT (format) | IOType |
| IMAGE (image) | FileID |
/api/rest/Country?[r=CountryID][&f=FolderID][&tag=String][&sharetoken=ShareTokenID][&format=IOType]
| RECORD (r) | CountryID |
| FOLDER (f) | FolderID |
| TAG (tag) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
/api/rest/Customer?a=PREVIEW[&default value=Boolean][&f=FolderID][&sharetoken=ShareTokenID]{&r=CustomerID}[&format=IOType]
| DEFAULT_VALUE (default value) | Boolean |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | CustomerID |
| FORMAT (format) | IOType |
/api/rest/Customer?a=CHANGE_PASSWORD{&expiretime=Integer}{&flags=Integer}{&r=CustomerID}{&minlength=Integer}[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID]
| EXPIRE_TIME (expiretime) | Integer (ID or number) |
| FLAGS (flags) | Integer (ID or number) |
| RECORD (r) | CustomerID |
| MINLENGTH (minlength) | Integer (ID or number) |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
/api/rest/Customer?a=CHANGE_IMAGE{&r=CustomerID}[&image=FileID][&sharetoken=ShareTokenID][&format=IOType][&f=FolderID]
| RECORD (r) | CustomerID |
| IMAGE (image) | FileID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
/api/rest/Document?[revision=DocumentRevisionID][&sharetoken=ShareTokenID][&p=ProjectID][&f=FolderID][&sort=SortValueID][&format=IOType][&limit=Integer][&offset=Integer][&r=DocumentID][&tag=String][&name=String][&doc=DocumentID]
| REVISION (revision) | DocumentRevisionID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
| FOLDER (f) | FolderID |
| SORT (sort) | SortValueID |
| FORMAT (format) | IOType |
| LIMIT (limit) | Integer (ID or number) |
| OFFSET (offset) | Integer (ID or number) |
| RECORD (r) | DocumentID |
| TAG (tag) | String |
| NAME (name) | String |
| DOCUMENT (doc) | DocumentID |
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][&sharetoken=ShareTokenID][&r=DocumentID][&timezone=TimeZoneID]
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | DocumentID |
| TIMEZONE (timezone) | TimeZoneID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Items"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("StatusID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MetaData"": [
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DocumentID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Unzip"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ReplaceLastRevision"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Content"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("UseOrgFileName"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Charset"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Tags"": [String],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FileName"": 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?{r=DocumentID}[&sharetoken=ShareTokenID][&status=DocumentStatusID][&format=IOType][&f=FolderID][&timezone=TimeZoneID]
| RECORD (r) | DocumentID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| STATUS (status) | DocumentStatusID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| TIMEZONE (timezone) | TimeZoneID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("StatusID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MetaData"": [
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String
}
/api/rest/Document?[format=IOType][&sharetoken=ShareTokenID][&f=FolderID]{&r=DocumentID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | DocumentID |
/api/rest/Document?a=MOVE[&timezone=TimeZoneID]{&f=FolderID}[&name=String]{&r=DocumentID}[&status=DocumentStatusID][&sharetoken=ShareTokenID][&format=IOType]
| TIMEZONE (timezone) | TimeZoneID |
| FOLDER (f) | FolderID |
| NAME (name) | String |
| RECORD (r) | DocumentID |
| STATUS (status) | DocumentStatusID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Items"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("StatusID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MetaData"": [
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DocumentID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Unzip"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ReplaceLastRevision"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Content"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("UseOrgFileName"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Charset"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Tags"": [String],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FileName"": String
}
]
}
/api/rest/Document?a=COPY{&f=FolderID}[&revision=DocumentRevisionID][&target=DocumentID][&message=Boolean][&all=Boolean]{&r=DocumentID}[&name=String][&format=IOType][&timezone=TimeZoneID][&status=DocumentStatusID][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| REVISION (revision) | DocumentRevisionID |
| TARGET (target) | DocumentID |
| MESSAGE (message) | Boolean |
| ALL (all) | Boolean |
| RECORD (r) | DocumentID |
| NAME (name) | String |
| FORMAT (format) | IOType |
| TIMEZONE (timezone) | TimeZoneID |
| STATUS (status) | DocumentStatusID |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Items"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("StatusID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MetaData"": [
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DocumentID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Unzip"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ReplaceLastRevision"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Content"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("UseOrgFileName"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Charset"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Tags"": [String],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FileName"": String
}
]
}
/api/rest/Document?a=PRINT[&sharetoken=ShareTokenID][&revision=Integer]{&timezone=TimeZoneID}[&format=IOType][&f=FolderID]{&r=DocumentID}[&p=ProjectID][&pg=Integer]
| SHARETOKEN (sharetoken) | ShareTokenID |
| REVISION (revision) | Integer (ID or number) |
| TIMEZONE (timezone) | TimeZoneID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| RECORD (r) | DocumentID |
| PROJECT (p) | ProjectID |
| PAGE (pg) | Integer (ID or number) |
/api/rest/Document?a=SEARCH[&after=String][&description=String][&extension=String][&content=String][&sharetoken=ShareTokenID][&status=DocumentStatusID][&before=String][&reservations=Boolean][&offset=Integer][&name=String][&f=FolderID]{&p=ProjectID}[&format=IOType][&contact=String]
| AFTER (after) | String |
| DESCRIPTION (description) | String |
| EXTENSION (extension) | String |
| CONTENT (content) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| STATUS (status) | DocumentStatusID |
| BEFORE (before) | String |
| RESERVATIONS (reservations) | Boolean |
| OFFSET (offset) | Integer (ID or number) |
| NAME (name) | String |
| FOLDER (f) | FolderID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| CONTACT (contact) | String |
/api/rest/Document?a=DOWNLOAD[&f=FolderID][&revision=DocumentRevisionID][&r=DocumentID][&includelinks=Boolean][&format=IOType][&lock=Boolean][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| REVISION (revision) | DocumentRevisionID |
| RECORD (r) | DocumentID |
| INCLUDE_LINKS (includelinks) | Boolean |
| FORMAT (format) | IOType |
| LOCK (lock) | Boolean |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=PREVIEW[&format=IOType][&f=FolderID][&width=Integer][&height=Integer][&sharetoken=ShareTokenID][&pg=Integer][&revision=Integer][&vw=Integer]{&r=DocumentID}
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| WIDTH (width) | Integer (ID or number) |
| HEIGHT (height) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PAGE (pg) | Integer (ID or number) |
| REVISION (revision) | Integer (ID or number) |
| VIEW (vw) | Integer (ID or number) |
| RECORD (r) | DocumentID |
/api/rest/Document?a=LOCK[&sharetoken=ShareTokenID][&f=FolderID][&format=IOType]{&r=DocumentID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| RECORD (r) | DocumentID |
/api/rest/Document?a=UNLOCK[&sharetoken=ShareTokenID]{&r=DocumentID}[&f=FolderID][&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | DocumentID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/Document?a=WORKFLOWATTACH[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID]{&r=DocumentID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | DocumentID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CoordinatorID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("WorkflowID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Status"": EventStatus
}
/api/rest/Document?a=SHARE[&f=FolderID]{&r=DocumentID}[&name=String][&format=IOType][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| RECORD (r) | DocumentID |
| NAME (name) | String |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=ADD_RESERVATION[&timezone=TimeZoneID][&sharetoken=ShareTokenID][&format=IOType]{&status=DocumentStatusID}{&f=FolderID}{&reservations=Integer}[&description=String]
| TIMEZONE (timezone) | TimeZoneID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| STATUS (status) | DocumentStatusID |
| FOLDER (f) | FolderID |
| RESERVATIONS (reservations) | Integer (ID or number) |
| DESCRIPTION (description) | String |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormRecords"": [
}
]
}
/api/rest/Document?a=DISABLE_SHARE[&sharetoken=ShareTokenID][&f=FolderID]{&r=DocumentID}[&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | DocumentID |
| FORMAT (format) | IOType |
/api/rest/Document?a=QRCODE[&f=FolderID][&size=Integer][&format=IOType]{&r=DocumentID}[&atype=String][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| SIZE (size) | Integer (ID or number) |
| FORMAT (format) | IOType |
| RECORD (r) | DocumentID |
| ACTIONTYPE (atype) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Document?a=SET_STATUS[&format=IOType][&f=FolderID]{&status=DocumentStatusID}[&sharetoken=ShareTokenID]{&r=DocumentID}
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| STATUS (status) | DocumentStatusID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | DocumentID |
/api/rest/Document?a=REMOVE_FROM_STORAGE[&format=IOType][&sharetoken=ShareTokenID]{&r=DocumentID}[&f=FolderID]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | DocumentID |
| FOLDER (f) | FolderID |
/api/rest/Document?a=PROMOTE_MAJOR_VERSION[&format=IOType]{&r=DocumentID}[&sharetoken=ShareTokenID][&f=FolderID]
| FORMAT (format) | IOType |
| RECORD (r) | DocumentID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
/api/rest/Document?a=NEW_MAIL{&r=DocumentID}{&to=String}[&message=String][&f=FolderID][&sharetoken=ShareTokenID][&format=IOType]
| RECORD (r) | DocumentID |
| TO (to) | String |
| MESSAGE (message) | String |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
/api/rest/DocumentShare?[doc=DocumentID][&f=FolderID][&sharetoken=ShareTokenID][&tag=String][&r=DocumentShareID][&format=IOType]
| DOCUMENT (doc) | DocumentID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| TAG (tag) | String |
| RECORD (r) | DocumentShareID |
| FORMAT (format) | IOType |
/api/rest/DocumentStatus?[sharetoken=ShareTokenID]{&p=ProjectID}[&format=IOType][&f=FolderID][&r=DocumentStatusID][&tag=String]
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| RECORD (r) | DocumentStatusID |
| TAG (tag) | String |
/api/rest/DocumentStatus?{p=ProjectID}[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID]
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Sequence"": int
}
/api/rest/DocumentStatus?[sharetoken=ShareTokenID]{&r=DocumentStatusID}{&p=ProjectID}[&format=IOType][&f=FolderID]
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | DocumentStatusID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Sequence"": int
}
/api/rest/DocumentStatus?[sharetoken=ShareTokenID][&format=IOType][&replace=DocumentStatusID]{&p=ProjectID}{&r=DocumentStatusID}[&f=FolderID]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| REPLACE (replace) | DocumentStatusID |
| PROJECT (p) | ProjectID |
| RECORD (r) | DocumentStatusID |
| FOLDER (f) | FolderID |
/api/rest/Event?[r=EventID][&offset=Integer][&sharetoken=ShareTokenID][&start=String][&limit=Integer][&end=String][&format=IOType][&f=FolderID][&p=ProjectID][&before=String][&tag=String][&event=EventID]
| RECORD (r) | EventID |
| OFFSET (offset) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| START (start) | String |
| LIMIT (limit) | Integer (ID or number) |
| END (end) | String |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| PROJECT (p) | ProjectID |
| BEFORE (before) | String |
| TAG (tag) | String |
| EVENT (event) | EventID |
/api/rest/Event?{f=FolderID}{&tzstart=String}{&tzend=String}[&format=IOType][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| TIMEZONE_START (tzstart) | String |
| TIMEZONE_END (tzend) | String |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Start"": Date,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("End"": Date,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Reminder"":
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ContactIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MailListIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Value"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Type"": ReminderType
},
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Status"": EventStatus,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Category"": EventCategory,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttendeeIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AskConfirmation"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("informAttendees"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachmentNames"": [String],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachmentIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Repeat"":
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Value"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Type"": RepeatType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("End"": Date
},
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttendeeMailListIDs"": [Integer]
}
/api/rest/Event?{tzend=String}[&sharetoken=ShareTokenID]{&tzstart=String}[&format=IOType]{&r=EventID}[&f=FolderID]
| TIMEZONE_END (tzend) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| TIMEZONE_START (tzstart) | String |
| FORMAT (format) | IOType |
| RECORD (r) | EventID |
| FOLDER (f) | FolderID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ApplyToFutureEvents"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Start"": Date,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("End"": Date,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Reminder"":
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ContactIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MailListIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Value"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Type"": ReminderType
},
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Status"": EventStatus,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Category"": EventCategory,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttendeeIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AskConfirmation"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("informAttendees"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachmentNames"": [String],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachmentIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Repeat"":
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Value"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Type"": RepeatType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("End"": Date
},
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttendeeMailListIDs"": [Integer]
}
/api/rest/Event?[f=FolderID][&sharetoken=ShareTokenID][&format=IOType]{&r=EventID}[&future=Boolean]
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| RECORD (r) | EventID |
| FUTURE (future) | Boolean |
/api/rest/Event?a=PRINT{&r=EventID}[&p=ProjectID]{&timezone=TimeZoneID}[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
| RECORD (r) | EventID |
| PROJECT (p) | ProjectID |
| TIMEZONE (timezone) | TimeZoneID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Event?a=DOWNLOAD[&f=FolderID]{&r=EventID}[&format=IOType][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| RECORD (r) | EventID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/EventAttendee?a=CONFIRM[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&r=EventAttendeeID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | EventAttendeeID |
/api/rest/EventAttendee?a=DENY[&sharetoken=ShareTokenID]{&r=EventAttendeeID}[&f=FolderID][&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | EventAttendeeID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/Folder?[ot=ItemType][&p=ProjectID][&parent=FolderID][&ftype=FolderType][&wfi=WorkflowInstanceID][&children=Boolean][&o=Integer][&admin=String][&r=FolderID][&tag=String][&all=Boolean][&f=FolderID][&sharetoken=ShareTokenID][&u=Integer][&format=IOType]
| OBJECT_TYPE (ot) | ItemType |
| PROJECT (p) | ProjectID |
| PARENT (parent) | FolderID |
| FOLDER_TYPE (ftype) | FolderType |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| CHILDREN (children) | Boolean |
| OBJECT_ID (o) | Integer (ID or number) |
| ADMIN (admin) | String |
| RECORD (r) | FolderID |
| TAG (tag) | String |
| ALL (all) | Boolean |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| USER (u) | Integer (ID or number) |
| FORMAT (format) | IOType |
/api/rest/Folder?[format=IOType][&image=FileID][&before=FolderID][&sharetoken=ShareTokenID][&parent=FolderID][&p=ProjectID][&f=FolderID][&admin=String]
| FORMAT (format) | IOType |
| IMAGE (image) | FileID |
| BEFORE (before) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PARENT (parent) | FolderID |
| PROJECT (p) | ProjectID |
| FOLDER (f) | FolderID |
| ADMIN (admin) | String |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("BinderDocumentStatus"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DocumentStatusID"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MailFunctionality"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("PreventSimultaneousEvents"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("StartOfDay"": Date,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("EndOfDay"": Date,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Server"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Path"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Password"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Username"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ProjectID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Sequence"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FolderType"": FolderType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FixedEventDuration"": String
}
/api/rest/Folder?[admin=String]{&r=FolderID}[&f=FolderID][&sharetoken=ShareTokenID][&format=IOType]
| ADMIN (admin) | String |
| RECORD (r) | FolderID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("BinderDocumentStatus"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DocumentStatusID"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MailFunctionality"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("PreventSimultaneousEvents"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("StartOfDay"": Date,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("EndOfDay"": Date,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Server"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Path"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Password"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Username"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ProjectID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Sequence"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FolderType"": FolderType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FixedEventDuration"": String
}
/api/rest/Folder?[sharetoken=ShareTokenID]{&r=FolderID}[&f=FolderID][&format=IOType][&simulate=String]
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | FolderID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SIMULATE (simulate) | String |
/api/rest/Folder?a=MOVE[&sharetoken=ShareTokenID][&format=IOType][&before=FolderID][&parent=Integer][&f=FolderID]{&r=FolderID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| BEFORE (before) | FolderID |
| PARENT (parent) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| RECORD (r) | FolderID |
/api/rest/Folder?a=COPY{&r=FolderID}[&sharetoken=ShareTokenID][&p=ProjectID][&format=IOType][&to=FolderID][&name=String]{&subfolders=Boolean}[&f=FolderID][&before=FolderID]
| RECORD (r) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| TO (to) | FolderID |
| NAME (name) | String |
| SUBFOLDERS (subfolders) | Boolean |
| FOLDER (f) | FolderID |
| BEFORE (before) | FolderID |
/api/rest/Folder?a=SEARCH[&u=UserID][&format=IOType]{&p=ProjectID}[&sharetoken=ShareTokenID][&f=FolderID]
| USER (u) | UserID |
| FORMAT (format) | IOType |
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
/api/rest/Folder?a=HISTORY{&f=FolderID}[&offset=Integer][&sharetoken=ShareTokenID][&format=IOType][&tag=String][&r=LogID]
| FOLDER (f) | FolderID |
| OFFSET (offset) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| TAG (tag) | String |
| RECORD (r) | LogID |
/api/rest/Folder?a=PREVIEW[&format=IOType]{&r=FolderID}[&f=FolderID][&default value=Boolean][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| RECORD (r) | FolderID |
| FOLDER (f) | FolderID |
| DEFAULT_VALUE (default value) | Boolean |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Folder?a=SHARE{&r=FolderID}[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID]
| RECORD (r) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
/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[&format=IOType][&f=FolderID][&image=FileID][&sharetoken=ShareTokenID]{&r=FolderID}
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| IMAGE (image) | FileID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | FolderID |
/api/rest/FolderAccess?[tag=String][&p=ProjectID][&sharetoken=ShareTokenID][&format=IOType][&f=FolderID][&role=RoleID][&r=FolderAccessID]
| TAG (tag) | String |
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| ROLE (role) | RoleID |
| RECORD (r) | FolderAccessID |
/api/rest/FolderAccess?[format=IOType][&subfolders=Boolean][&sharetoken=ShareTokenID]{&f=FolderID}[&role=RoleID]
| FORMAT (format) | IOType |
| SUBFOLDERS (subfolders) | Boolean |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| ROLE (role) | RoleID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachFormOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("EditOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Annotate"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AddSubfolder"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AddRevisionOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Share"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AddRevision"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Add"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachWorkflow"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Print"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Download"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachForm"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ShareOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachWorkflowOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ViewOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Edit"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DeleteOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Delete"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("View"": boolean
}
/api/rest/FolderAccess?[f=FolderID][&sharetoken=ShareTokenID][&format=IOType][&role=RoleID]
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| ROLE (role) | RoleID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FolderAccess"": {
String:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachFormOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("EditOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Annotate"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AddSubfolder"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AddRevisionOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Share"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AddRevision"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Add"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachWorkflow"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Print"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Download"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachForm"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ShareOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachWorkflowOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ViewOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Edit"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DeleteOwn"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Delete"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("View"": boolean
}
}
}
/api/rest/FolderAccess?a=COPY{&parent=FolderID}[&sharetoken=ShareTokenID][&format=IOType]{&f=FolderID}
| PARENT (parent) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
/api/rest/FolderAccessSnapshot?[sharetoken=ShareTokenID][&tag=String][&f=FolderID][&r=FolderAccessSnapshotID][&format=IOType]{&p=ProjectID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| TAG (tag) | String |
| FOLDER (f) | FolderID |
| RECORD (r) | FolderAccessSnapshotID |
| FORMAT (format) | IOType |
| PROJECT (p) | ProjectID |
/api/rest/FolderAccessSnapshot?{r=FolderAccessSnapshotID}[&f=FolderID][&sharetoken=ShareTokenID][&format=IOType]
| RECORD (r) | FolderAccessSnapshotID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
/api/rest/FolderAccessSnapshot?a=PREVIEW[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&p=ProjectID}[&r=FolderID]{&snapshot=FolderAccessSnapshotID}[&tag=String]
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
| RECORD (r) | FolderID |
| FOLDERACCESS_SNAPSHOT (snapshot) | FolderAccessSnapshotID |
| TAG (tag) | String |
/api/rest/FolderAccessSnapshot?a=CREATE[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID]{&name=String}{&p=ProjectID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| NAME (name) | String |
| PROJECT (p) | ProjectID |
/api/rest/FolderAccessSnapshot?a=REVERT{&p=ProjectID}{&r=FolderAccessSnapshotID}[&sharetoken=ShareTokenID][&format=IOType][&f=FolderID]
| PROJECT (p) | ProjectID |
| RECORD (r) | FolderAccessSnapshotID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
/api/rest/FolderSubscription?[f=FolderID][&r=FolderSubscriptionID][&sharetoken=ShareTokenID][&tag=String][&admin=String][&format=IOType][&p=ProjectID]
| FOLDER (f) | FolderID |
| RECORD (r) | FolderSubscriptionID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| TAG (tag) | String |
| ADMIN (admin) | String |
| FORMAT (format) | IOType |
| PROJECT (p) | ProjectID |
/api/rest/FolderSubscription?[sharetoken=ShareTokenID][&p=ProjectID][&f=FolderID][&format=IOType][&admin=String]{&hour=Integer}
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| ADMIN (admin) | String |
| HOUR (hour) | Integer (ID or number) |
/api/rest/FolderSubscription?[f=FolderID][&admin=String][&format=IOType][&sharetoken=ShareTokenID]{&p=ProjectID}{&hour=Integer}
| FOLDER (f) | FolderID |
| ADMIN (admin) | String |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
| HOUR (hour) | Integer (ID or number) |
/api/rest/FolderSubscription?[format=IOType][&admin=String][&p=ProjectID][&sharetoken=ShareTokenID][&f=FolderID]
| FORMAT (format) | IOType |
| ADMIN (admin) | String |
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
/api/rest/Form?[r=FormID][&tag=String][&p=ProjectID][&f=FolderID][&format=IOType][&metadata=Boolean][&sharetoken=ShareTokenID][&admin=String][&itemkey=ItemID]
| RECORD (r) | FormID |
| TAG (tag) | String |
| PROJECT (p) | ProjectID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| METADATA (metadata) | Boolean |
| SHARETOKEN (sharetoken) | ShareTokenID |
| ADMIN (admin) | String |
| ITEMKEY (itemkey) | ItemID |
/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:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormField"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Parent"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Form"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Required"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Height"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Width"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Options"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormField"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Value"": String
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Sequence"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Column"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("OrgID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Rights"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Role"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormField"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Column"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanView"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanAdd"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanEdit"": boolean
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormFieldType"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("X"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Y"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Children"": [FormFieldPayload]
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Options"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Value"": String
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Folder"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Rights"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Form"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Role"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Table"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanView"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanAdd"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanEdit"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanDelete"": boolean
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Author"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Table"": int
}
/api/rest/Form?[sharetoken=ShareTokenID][&format=IOType]{&r=FormID}{&f=FolderID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| RECORD (r) | FormID |
| FOLDER (f) | FolderID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormField"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Parent"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Form"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Required"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Height"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Width"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Options"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormField"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Value"": String
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Sequence"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Column"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("OrgID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Rights"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Role"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormField"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Column"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanView"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanAdd"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanEdit"": boolean
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormFieldType"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("X"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Y"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Children"": [FormFieldPayload]
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Options"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Value"": String
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Folder"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Rights"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Form"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Role"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Table"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanView"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanAdd"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanEdit"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanDelete"": boolean
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Author"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Table"": int
}
/api/rest/Form?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&r=FormID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | FormID |
/api/rest/Form?a=MOVE{&r=FormID}[&sharetoken=ShareTokenID][&name=String]{&f=FolderID}[&format=IOType]
| RECORD (r) | FormID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| NAME (name) | String |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/Form?a=COPY[&name=String]{&r=FormID}[©data=Boolean]{&f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]
| NAME (name) | String |
| RECORD (r) | FormID |
| COPY_DATA (copydata) | Boolean |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FormRow?[r=FormRowID][&f=FolderID][&itemkey=ItemID][&tag=String][&form=FormID][&format=IOType][&sharetoken=ShareTokenID][&row=Integer]
| RECORD (r) | FormRowID |
| FOLDER (f) | FolderID |
| ITEMKEY (itemkey) | ItemID |
| TAG (tag) | String |
| FORM (form) | FormID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| ROW (row) | Integer (ID or number) |
/api/rest/FormRow?{form=FormID}{&ot=ItemType}[&f=FolderID]{&row=Integer}[&sharetoken=ShareTokenID]{&o=Integer}[&format=IOType]
| FORM (form) | FormID |
| OBJECT_TYPE (ot) | ItemType |
| FOLDER (f) | FolderID |
| ROW (row) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| OBJECT_ID (o) | Integer (ID or number) |
| FORMAT (format) | IOType |
/api/rest/FormRow?[format=IOType][&row=Integer][&f=FolderID]{&r=FormRowID}[&form=FormID][&itemkey=ItemID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| ROW (row) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| RECORD (r) | FormRowID |
| FORM (form) | FormID |
| ITEMKEY (itemkey) | ItemID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/FormRecord?[o=Integer][&revision=DocumentRevisionID][&f=FolderID][&references=Boolean][&limit=Integer][&sharetoken=ShareTokenID][&offset=Integer][&form=FormID][&format=IOType][&doc=DocumentID][&r=FormID][&row=Integer]
| OBJECT_ID (o) | Integer (ID or number) |
| REVISION (revision) | DocumentRevisionID |
| FOLDER (f) | FolderID |
| REFERENCES (references) | Boolean |
| LIMIT (limit) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| OFFSET (offset) | Integer (ID or number) |
| FORM (form) | FormID |
| FORMAT (format) | IOType |
| DOCUMENT (doc) | DocumentID |
| RECORD (r) | FormID |
| ROW (row) | Integer (ID or number) |
/api/rest/FormRecord?[format=IOType][&f=FolderID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| 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?[sharetoken=ShareTokenID][&row=Integer]{&r=FormID}[&f=FolderID][&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| ROW (row) | Integer (ID or number) |
| RECORD (r) | FormID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/FormRecord?a=SEARCH[&metadata=Boolean][&format=IOType][&f=FolderID][&sharetoken=ShareTokenID][&operator=String][&key=String]
| METADATA (metadata) | Boolean |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| OPERATOR (operator) | String |
| KEY (key) | String |
This call requires a request payload that should look like:
}
/api/rest/FormRecord?a=LINK[&format=IOType]{&targetids=Integer}{&target=FormID}{&sourceids=Integer}{&source=FormID}[&f=FolderID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| TARGETIDS (targetids) | Integer (ID or number) |
| TARGET (target) | FormID |
| SOURCEIDS (sourceids) | Integer (ID or number) |
| SOURCE (source) | FormID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/ForumPost?[sharetoken=ShareTokenID][&format=IOType][&tag=String][&forumpost=ForumPostID][&r=ForumPostID][&f=FolderID]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| TAG (tag) | String |
| FORUMPOST (forumpost) | ForumPostID |
| RECORD (r) | ForumPostID |
| FOLDER (f) | FolderID |
/api/rest/ForumPost?[format=IOType]{&f=FolderID}[&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?[format=IOType]{&r=ForumPostID}[&f=FolderID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| RECORD (r) | ForumPostID |
| FOLDER (f) | FolderID |
| 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][&sharetoken=ShareTokenID]{&forumpost=ForumPostID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORUMPOST (forumpost) | ForumPostID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?a=SUBSCRIBE[&sharetoken=ShareTokenID]{&r=ForumPostID}[&f=FolderID][&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | ForumPostID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/ForumPost?a=UNSUBSCRIBE[&format=IOType][&sharetoken=ShareTokenID]{&r=ForumPostID}[&f=FolderID]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | ForumPostID |
| FOLDER (f) | FolderID |
/api/rest/ForumPost?[f=FolderID][&forumpost=ForumPostID][&tag=String][&r=ForumPostID][&format=IOType][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| FORUMPOST (forumpost) | ForumPostID |
| TAG (tag) | String |
| RECORD (r) | ForumPostID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/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?[format=IOType]{&r=ForumPostID}[&f=FolderID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| RECORD (r) | ForumPostID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?[format=IOType][&f=FolderID][&sharetoken=ShareTokenID]{&r=ForumPostID}
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | ForumPostID |
/api/rest/ForumPost?a=REPLY[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&forumpost=ForumPostID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORUMPOST (forumpost) | ForumPostID |
This call requires a request payload that should look like:
}
/api/rest/ForumPost?a=SUBSCRIBE[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&r=ForumPostID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | ForumPostID |
/api/rest/ForumPost?a=UNSUBSCRIBE{&r=ForumPostID}[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
| RECORD (r) | ForumPostID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Guest?{p=ProjectID}[&sharetoken=ShareTokenID][&format=IOType][&f=FolderID]{&role=RoleID}
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| ROLE (role) | RoleID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Password"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Username"": String
}
/api/rest/Guest?[f=FolderID]{&r=UserID}[&sharetoken=ShareTokenID][&format=IOType]
| FOLDER (f) | FolderID |
| RECORD (r) | UserID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Password"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Username"": String
}
/api/rest/CSVHeaders?{file=String}[&tag=String][&sharetoken=ShareTokenID][&format=IOType][&f=FolderID][&r=CSVHeadersID]
| FILE (file) | String |
| TAG (tag) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| RECORD (r) | CSVHeadersID |
/api/rest/Language?[tag=String][&f=FolderID][&format=IOType][&r=LanguageID][&sharetoken=ShareTokenID]
| TAG (tag) | String |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| RECORD (r) | LanguageID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/LinkedDocument?[annotation3d=Annotation3DID][&f=FolderID][&itemkey=ItemID][&annotation=Annotation2DID][&doc=DocumentID][&row=Integer][&target=LinkedDocumentDirection][¬ification=NotificationID][&format=IOType][&sharetoken=ShareTokenID][¬e=NoteID][&form=FormID][&tag=String][&revision=DocumentRevisionID][&wfi=WorkflowInstanceID]
| ANNOTATION3D (annotation3d) | Annotation3DID |
| FOLDER (f) | FolderID |
| ITEMKEY (itemkey) | ItemID |
| ANNOTATION (annotation) | Annotation2DID |
| DOCUMENT (doc) | DocumentID |
| ROW (row) | Integer (ID or number) |
| TARGET (target) | LinkedDocumentDirection |
| NOTIFICATION (notification) | NotificationID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| NOTE (note) | NoteID |
| FORM (form) | FormID |
| TAG (tag) | String |
| REVISION (revision) | DocumentRevisionID |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
/api/rest/LinkedDocument?[format=IOType]{&r=DocumentID}[&f=FolderID]{&itemkey=ItemID}[&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| RECORD (r) | DocumentID |
| FOLDER (f) | FolderID |
| ITEMKEY (itemkey) | ItemID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/LinkedDocument?[targetrevision=DocumentRevisionID][&format=IOType][&sharetoken=ShareTokenID][&targetdocument=DocumentID][&sourcerevision=DocumentRevisionID][&f=FolderID][&sourcedocument=DocumentID]
| TARGETREVISION (targetrevision) | DocumentRevisionID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| TARGETDOCUMENT (targetdocument) | DocumentID |
| SOURCEREVISION (sourcerevision) | DocumentRevisionID |
| FOLDER (f) | FolderID |
| SOURCEDOCUMENT (sourcedocument) | DocumentID |
/api/rest/Log?[f=FolderID][&r=LogID][&p=ProjectID][&o=Integer][&format=IOType][&tag=String][&sharetoken=ShareTokenID][&offset=Integer][&limit=Integer][&ot=Integer]
| FOLDER (f) | FolderID |
| RECORD (r) | LogID |
| PROJECT (p) | ProjectID |
| OBJECT_ID (o) | Integer (ID or number) |
| FORMAT (format) | IOType |
| TAG (tag) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| OFFSET (offset) | Integer (ID or number) |
| LIMIT (limit) | Integer (ID or number) |
| OBJECT_TYPE (ot) | Integer (ID or number) |
/api/rest/Log?a=SEARCH{&p=ProjectID}[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID][&after=String][&limit=Integer][&atype=Integer][&u=UserID][&before=String][&t=Integer][&offset=Integer]
| PROJECT (p) | ProjectID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| AFTER (after) | String |
| LIMIT (limit) | Integer (ID or number) |
| ACTIONTYPE (atype) | Integer (ID or number) |
| USER (u) | UserID |
| BEFORE (before) | String |
| TYPE (t) | Integer (ID or number) |
| OFFSET (offset) | Integer (ID or number) |
/api/rest/LogRecent?[sharetoken=ShareTokenID][&tag=String][&o=Integer][&limit=Integer][&ot=Integer][&f=FolderID][&format=IOType][&p=ProjectID][&r=LogID][&offset=Integer]
| SHARETOKEN (sharetoken) | ShareTokenID |
| TAG (tag) | String |
| OBJECT_ID (o) | Integer (ID or number) |
| LIMIT (limit) | Integer (ID or number) |
| OBJECT_TYPE (ot) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| PROJECT (p) | ProjectID |
| RECORD (r) | LogID |
| OFFSET (offset) | Integer (ID or number) |
/api/rest/LogRecent?a=SEARCH{&p=ProjectID}[&format=IOType][&f=FolderID][&limit=Integer][&u=UserID][&offset=Integer][&t=Integer][&after=String][&atype=Integer][&before=String][&sharetoken=ShareTokenID]
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| LIMIT (limit) | Integer (ID or number) |
| USER (u) | UserID |
| OFFSET (offset) | Integer (ID or number) |
| TYPE (t) | Integer (ID or number) |
| AFTER (after) | String |
| ACTIONTYPE (atype) | Integer (ID or number) |
| BEFORE (before) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/LogRoot?[format=IOType][&sharetoken=ShareTokenID][&o=Integer][&ot=Integer][&offset=Integer][&f=FolderID][&p=ProjectID][&tag=String][&r=LogID][&limit=Integer]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| OBJECT_ID (o) | Integer (ID or number) |
| OBJECT_TYPE (ot) | Integer (ID or number) |
| OFFSET (offset) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| PROJECT (p) | ProjectID |
| TAG (tag) | String |
| RECORD (r) | LogID |
| LIMIT (limit) | Integer (ID or number) |
/api/rest/LogRoot?a=SEARCH[&sharetoken=ShareTokenID][&after=String][&format=IOType][&u=UserID]{&p=ProjectID}[&before=String][&offset=Integer][&atype=Integer][&f=FolderID][&limit=Integer][&t=Integer]
| SHARETOKEN (sharetoken) | ShareTokenID |
| AFTER (after) | String |
| FORMAT (format) | IOType |
| USER (u) | UserID |
| PROJECT (p) | ProjectID |
| BEFORE (before) | String |
| OFFSET (offset) | Integer (ID or number) |
| ACTIONTYPE (atype) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| LIMIT (limit) | Integer (ID or number) |
| TYPE (t) | Integer (ID or number) |
/api/rest/MailList?[f=FolderID][&r=MailListID][&tag=String][&format=IOType][&p=ProjectID][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| RECORD (r) | MailListID |
| TAG (tag) | String |
| FORMAT (format) | IOType |
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Message?[f=FolderID][&tag=String][&p=ProjectID][&format=IOType][&limit=Integer][&r=MessageID][&offset=Integer][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| TAG (tag) | String |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| LIMIT (limit) | Integer (ID or number) |
| RECORD (r) | MessageID |
| OFFSET (offset) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Message?[format=IOType]{&f=FolderID}[&sharetoken=ShareTokenID][&ff=MessageID]
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORWARDED_FROM (ff) | MessageID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AttachmentNames"": [String],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ToID"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("BccID"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CcID"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Document"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Subject"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Body"": String
}
/api/rest/Message?[f=FolderID]{&r=MessageID}[&format=IOType][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| RECORD (r) | MessageID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Message?a=MOVE{&f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]{&r=MessageID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | MessageID |
/api/rest/Message?a=PRINT[&sharetoken=ShareTokenID][&f=FolderID]{&timezone=TimeZoneID}[&p=ProjectID][&format=IOType]{&r=MessageID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| TIMEZONE (timezone) | TimeZoneID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| RECORD (r) | MessageID |
/api/rest/Message?a=SEARCH[&subject=String][&before=String][&f=FolderID]{&p=ProjectID}[&format=IOType][&after=String][&receiver=String][&t=MessageType][&sender=String][&message=String][&sharetoken=ShareTokenID]
| SUBJECT (subject) | String |
| BEFORE (before) | String |
| FOLDER (f) | FolderID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| AFTER (after) | String |
| RECEIVER (receiver) | String |
| TYPE (t) | MessageType |
| SENDER (sender) | String |
| MESSAGE (message) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Message?a=WORKFLOWATTACH[&sharetoken=ShareTokenID][&f=FolderID]{&r=MessageID}[&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | MessageID |
| FORMAT (format) | IOType |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CoordinatorID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("WorkflowID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Status"": EventStatus
}
/api/rest/Message?a=NEW_MAIL[&sharetoken=ShareTokenID]{&p=ProjectID}[&f=FolderID][&r=MessageID][&format=IOType][&tag=String]
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
| FOLDER (f) | FolderID |
| RECORD (r) | MessageID |
| FORMAT (format) | IOType |
| TAG (tag) | String |
/api/rest/RepositoryLink?[f=FolderID][&r=RepositoryLinkID][&p=ProjectID][&tag=String][&format=IOType][&form=FormID][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| RECORD (r) | RepositoryLinkID |
| PROJECT (p) | ProjectID |
| TAG (tag) | String |
| FORMAT (format) | IOType |
| FORM (form) | FormID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/RepositoryLink?[set default=Boolean][&sharetoken=ShareTokenID]{&form=FormID}{&f=FolderID}[&format=IOType][&delimiter=String][&subfolders=Boolean][&revisions=Boolean]
| SET_DEFAULT (set default) | Boolean |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORM (form) | FormID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| DELIMITER (delimiter) | String |
| SUBFOLDERS (subfolders) | Boolean |
| REVISIONS (revisions) | Boolean |
This call requires a request payload that should look like:
}
/api/rest/RepositoryLink?[set default=Boolean][&subfolders=Boolean]{&f=FolderID}{&form=FormID}{&repositorylink=Integer}[&sharetoken=ShareTokenID][&format=IOType][&revisions=Boolean][&delimiter=String]
| SET_DEFAULT (set default) | Boolean |
| SUBFOLDERS (subfolders) | Boolean |
| FOLDER (f) | FolderID |
| FORM (form) | FormID |
| REPOSITORYLINK (repositorylink) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| REVISIONS (revisions) | Boolean |
| DELIMITER (delimiter) | String |
This call requires a request payload that should look like:
}
/api/rest/RepositoryLink?{f=FolderID}[&sharetoken=ShareTokenID][&format=IOType]{&form=FormID}
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FORM (form) | FormID |
/api/rest/RepositoryLink?a=COPY[&format=IOType][&sharetoken=ShareTokenID]{&from=FolderID}[&f=FolderID]{&to=FolderID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FROM (from) | FolderID |
| FOLDER (f) | FolderID |
| TO (to) | FolderID |
/api/rest/Note?[format=IOType][&ot=ItemType][&sharetoken=ShareTokenID][&f=FolderID][&r=NoteID][&tag=String][&o=Integer]
| FORMAT (format) | IOType |
| OBJECT_TYPE (ot) | ItemType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | NoteID |
| TAG (tag) | String |
| OBJECT_ID (o) | Integer (ID or number) |
/api/rest/Note?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&parent=ItemID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PARENT (parent) | ItemID |
This call requires a request payload that should look like:
}
/api/rest/Note?[format=IOType]{&r=NoteID}[&sharetoken=ShareTokenID][&f=FolderID]
| FORMAT (format) | IOType |
| RECORD (r) | NoteID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
This call requires a request payload that should look like:
}
/api/rest/Note?[sharetoken=ShareTokenID]{&r=NoteID}[&f=FolderID][&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | NoteID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/Notification?[o=Integer][&tag=String][&f=FolderID][&format=IOType][&ot=ItemType][&sharetoken=ShareTokenID][&r=NotificationID]
| OBJECT_ID (o) | Integer (ID or number) |
| TAG (tag) | String |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| OBJECT_TYPE (ot) | ItemType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | NotificationID |
/api/rest/Notification?[f=FolderID]{&tzend=String}{&tzstart=String}[&sharetoken=ShareTokenID]{&o=ItemID}[&p=ProjectID][&format=IOType]
| FOLDER (f) | FolderID |
| TIMEZONE_END (tzend) | String |
| TIMEZONE_START (tzstart) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| OBJECT_ID (o) | ItemID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
This call requires a request payload that should look like:
}
/api/rest/Notification?a=PRINT[&p=ProjectID]{&r=NotificationID}{&timezone=TimeZoneID}[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID]
| PROJECT (p) | ProjectID |
| RECORD (r) | NotificationID |
| TIMEZONE (timezone) | TimeZoneID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
/api/rest/Organization?[f=FolderID][&format=IOType][&admin=String][&tag=String][&p=ProjectID][&sharetoken=ShareTokenID][&r=OrganizationID]
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| ADMIN (admin) | String |
| TAG (tag) | String |
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | OrganizationID |
/api/rest/Organization?{f=FolderID}[&sharetoken=ShareTokenID][&format=IOType]
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Function"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("State"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Address"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Email"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("City"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Fax"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Phone"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Zip"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("VAT"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Website"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CountryID"": int
}
/api/rest/Organization?[format=IOType][&sharetoken=ShareTokenID]{&r=OrganizationID}{&f=FolderID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | OrganizationID |
| FOLDER (f) | FolderID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Function"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("State"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Address"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Email"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("City"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Fax"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Phone"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Zip"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("VAT"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Website"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CountryID"": int
}
/api/rest/Organization?{f=FolderID}[&format=IOType][&sharetoken=ShareTokenID]{&r=OrganizationID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | OrganizationID |
/api/rest/Organization?a=MOVE[&sharetoken=ShareTokenID]{&r=OrganizationID}{&f=FolderID}{&from=FolderID}[&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | OrganizationID |
| FOLDER (f) | FolderID |
| FROM (from) | FolderID |
| FORMAT (format) | IOType |
/api/rest/Organization?a=COPY{&from=FolderID}[&sharetoken=ShareTokenID]{&f=FolderID}[&format=IOType]{&r=OrganizationID}
| FROM (from) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| RECORD (r) | OrganizationID |
/api/rest/Organization?a=PRINT{&f=FolderID}{&timezone=TimeZoneID}[&r=OrganizationID][&format=IOType][&p=ProjectID][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| TIMEZONE (timezone) | TimeZoneID |
| RECORD (r) | OrganizationID |
| FORMAT (format) | IOType |
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Organization?a=IMPORT[&sharetoken=ShareTokenID][&format=IOType]{&p=ProjectID}{&f=FolderID}[&members=Boolean]{&r=OrganizationID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| PROJECT (p) | ProjectID |
| FOLDER (f) | FolderID |
| MEMBERS (members) | Boolean |
| RECORD (r) | OrganizationID |
/api/rest/Organization?a=SEARCH{&s=String}[&sharetoken=ShareTokenID][&f=FolderID][&format=IOType]
| SEARCH (s) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/Organization?a=DOWNLOAD[&format=IOType]{&f=FolderID}[&sharetoken=ShareTokenID]{&r=OrganizationID}
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | OrganizationID |
/api/rest/Project?[tag=String][&allcustomers=Boolean][&f=FolderID][&format=IOType][&active=Boolean][&filter=ProjectType][&customer=CustomerID][&sharetoken=ShareTokenID][&wfi=WorkflowInstanceID][&u=UserID][&customerids=Integer][&workflow=WorkflowID][&r=ProjectID][&admin=Boolean][&size=Boolean]
| TAG (tag) | String |
| ALL_CUSTOMERS (allcustomers) | Boolean |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| ACTIVE (active) | Boolean |
| FILTER (filter) | ProjectType |
| CUSTOMER (customer) | CustomerID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| USER (u) | UserID |
| CUSTOMER_IDS (customerids) | Integer (ID or number) |
| WORKFLOW (workflow) | WorkflowID |
| RECORD (r) | ProjectID |
| ADMIN (admin) | Boolean |
| SIZE (size) | Boolean |
/api/rest/Project?[logoname=FileID][&document status list=Boolean][&admin_folder_subscriptions=Boolean]{&name=String}[&users=Boolean][&format=IOType][&description=String][&addressbook data=Boolean][&template=Integer][&country=Integer][&sharetoken=ShareTokenID][&metadata=Boolean][&binder content=Boolean][&autoworkflows=Boolean][&workflows=Boolean][&binder settings=Boolean][&folders=Boolean][&forms=Boolean]{&customer=CustomerID}[&webhooks=Boolean][&roles=Boolean][&f=FolderID]
| LOGONAME (logoname) | FileID |
| DOCUMENT_STATUS_LIST (document status list) | Boolean |
| ADMIN_FOLDER_SUBSCRIPTIONS (admin_folder_subscriptions) | Boolean |
| NAME (name) | String |
| USERS (users) | Boolean |
| FORMAT (format) | IOType |
| DESCRIPTION (description) | String |
| ADDRESSBOOK_DATA (addressbook data) | Boolean |
| TEMPLATE (template) | Integer (ID or number) |
| COUNTRY (country) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| METADATA (metadata) | Boolean |
| BINDER_CONTENT (binder content) | Boolean |
| AUTOWORKFLOWS (autoworkflows) | Boolean |
| WORKFLOWS (workflows) | Boolean |
| BINDER_SETTINGS (binder settings) | Boolean |
| FOLDERS (folders) | Boolean |
| FORMS (forms) | Boolean |
| CUSTOMER (customer) | CustomerID |
| WEBHOOKS (webhooks) | Boolean |
| ROLES (roles) | Boolean |
| FOLDER (f) | FolderID |
/api/rest/Project?[limit=Integer][&format=IOType][&sharetoken=ShareTokenID][&f=FolderID]{&r=ProjectID}
| LIMIT (limit) | Integer (ID or number) |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | ProjectID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FirstDayOfWeek"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Address"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Flags"":
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MultiFactor"": Boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ReplaceDocumentRevisions"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LockPastEvents"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LockedRecycleBin"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DeleteRevisions"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DisplaySignature"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("AdminCanViewMessages"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanLockDocuments"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MultiFactor"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("DescriptionInNameForDownload"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MajorMinorVersionEnabled"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("VueInterfaceAsDefault"": boolean
},
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("City"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Zip"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Details"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("RevisionCounterType"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("MajorRevisionCounterType"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("WeekendDays"":
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Monday"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Tuesday"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Wednesday"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Thursday"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Friday"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Saturday"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Sunday"": boolean
},
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CountryID"": int
}
/api/rest/Project?[format=IOType]{&r=ProjectID}[&f=FolderID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| RECORD (r) | ProjectID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=UNDELETE[&f=FolderID][&sharetoken=ShareTokenID]{&r=ProjectID}[&format=IOType]
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | ProjectID |
| FORMAT (format) | IOType |
/api/rest/Project?a=DELETEHARD{&r=ProjectID}[&f=FolderID][&sharetoken=ShareTokenID][&format=IOType]
| RECORD (r) | ProjectID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
/api/rest/Project?a=ACTIVATE[&format=IOType][&f=FolderID]{&r=ProjectID}[&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| RECORD (r) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=DEACTIVATE{&r=ProjectID}[&format=IOType][&f=FolderID][&sharetoken=ShareTokenID]
| RECORD (r) | ProjectID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=PREVIEW[&f=FolderID][&format=IOType]{&r=ProjectID}[&default value=Boolean][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| RECORD (r) | ProjectID |
| DEFAULT_VALUE (default value) | Boolean |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=SET_DEFAULT_STATUS{&r=ProjectID}[&f=FolderID][&status=DocumentStatusID][&format=IOType][&sharetoken=ShareTokenID]
| RECORD (r) | ProjectID |
| FOLDER (f) | FolderID |
| STATUS (status) | DocumentStatusID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Project?a=CHANGE_IMAGE[&format=IOType]{&r=ProjectID}[&f=FolderID][&image=FileID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| RECORD (r) | ProjectID |
| FOLDER (f) | FolderID |
| IMAGE (image) | FileID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/RepositoryQuery?[r=RepositoryQueryID][&format=IOType][&tag=String][&p=ProjectID][&sharetoken=ShareTokenID][&f=FolderID]
| RECORD (r) | RepositoryQueryID |
| FORMAT (format) | IOType |
| TAG (tag) | String |
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
/api/rest/RepositoryQuery?a=RUN{&r=RepositoryQueryID}[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
| RECORD (r) | RepositoryQueryID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Parameters"": [String]
}
/api/rest/RecycleBin?[tag=String][&offset=Integer][&limit=Integer][&t=ItemType][&format=IOType][&sharetoken=ShareTokenID][&folders=Boolean]{&p=ProjectID}
| TAG (tag) | String |
| OFFSET (offset) | Integer (ID or number) |
| LIMIT (limit) | Integer (ID or number) |
| TYPE (t) | ItemType |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDERS (folders) | Boolean |
| PROJECT (p) | ProjectID |
/api/rest/RecycleBin?[simulate=String][&withitems=Boolean][&f=FolderID]{&itemkey=ItemID}[&sharetoken=ShareTokenID][&limit=Integer][&format=IOType]
| SIMULATE (simulate) | String |
| WITH_ITEMS (withitems) | Boolean |
| FOLDER (f) | FolderID |
| ITEMKEY (itemkey) | ItemID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| LIMIT (limit) | Integer (ID or number) |
| FORMAT (format) | IOType |
/api/rest/RecycleBin?a=UNDELETE[&f=FolderID][&sharetoken=ShareTokenID]{&itemkey=String}[&format=IOType]
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| ITEMKEY (itemkey) | String |
| FORMAT (format) | IOType |
/api/rest/RepositoryTable?[tag=String][&r=RepositoryTableID][&sharetoken=ShareTokenID][&format=IOType][&form=FormID][&f=FolderID][&admin=String][&p=ProjectID]
| TAG (tag) | String |
| RECORD (r) | RepositoryTableID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FORM (form) | FormID |
| FOLDER (f) | FolderID |
| ADMIN (admin) | String |
| PROJECT (p) | ProjectID |
/api/rest/RepositoryTable?[format=IOType][&sharetoken=ShareTokenID][&f=FolderID]{&r=RepositoryTableID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | RepositoryTableID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Table"":
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Form"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Role"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Table"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanView"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanAdd"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanEdit"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanDelete"": boolean
},
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Columns"": [
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Role"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FormField"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Column"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanView"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanAdd"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanEdit"": boolean
}
],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectType"": ItemType
}
/api/rest/RepositoryTable?a=IMPORTCSV[&document_header_index=Integer]{&r=RepositoryTableID}{&file=String}[&f=FolderID][&revision_header_index=Integer][&sharetoken=ShareTokenID]{&mapping=String}[&format=IOType]
| DOCUMENT_HEADER_INDEX (document_header_index) | Integer (ID or number) |
| RECORD (r) | RepositoryTableID |
| FILE (file) | String |
| FOLDER (f) | FolderID |
| REVISION_HEADER_INDEX (revision_header_index) | Integer (ID or number) |
| SHARETOKEN (sharetoken) | ShareTokenID |
| MAPPING (mapping) | String |
| FORMAT (format) | IOType |
/api/rest/Role?[admin=String][&tag=String][&s=String][&f=FolderID][&sharetoken=ShareTokenID][&p=ProjectID][&format=IOType][&r=RoleID]
| ADMIN (admin) | String |
| TAG (tag) | String |
| SEARCH (s) | String |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| RECORD (r) | RoleID |
/api/rest/Role?[cpaccess=RoleID][&import=Boolean][&role=RoleID][&sharetoken=ShareTokenID][&format=IOType][&f=FolderID][&cpmembers=RoleID]{&p=ProjectID}
| COPY_ACCESS (cpaccess) | RoleID |
| IMPORT (import) | Boolean |
| ROLE (role) | RoleID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| COPY_MEMBERS (cpmembers) | RoleID |
| PROJECT (p) | ProjectID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Color"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanViewReports"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanEditProfile"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanSeeOtherUsers"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanViewDocumentRevisions"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("IsMailList"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("TodoAdmin"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Users"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ColorHex"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("IsGuestRole"": boolean
}
/api/rest/Role?[format=IOType][&f=FolderID][&sharetoken=ShareTokenID]{&r=RoleID}
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | RoleID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Color"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanViewReports"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanEditProfile"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanSeeOtherUsers"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CanViewDocumentRevisions"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("IsMailList"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("TodoAdmin"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Users"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ColorHex"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("IsGuestRole"": boolean
}
/api/rest/Role?[format=IOType][&sharetoken=ShareTokenID][&f=FolderID]{&r=RoleID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | RoleID |
/api/rest/RoleMember?[role=RoleID][&u=UserID][&f=FolderID][&sharetoken=ShareTokenID][&r=RoleMemberID][&p=ProjectID][&format=IOType][&tag=String]
| ROLE (role) | RoleID |
| USER (u) | UserID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | RoleMemberID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| TAG (tag) | String |
/api/rest/RoleMember?[organization=OrganizationID]{&contact=ContactID}[&f=FolderID]{&role=RoleID}[&format=IOType][&sharetoken=ShareTokenID]
| ORGANIZATION (organization) | OrganizationID |
| CONTACT (contact) | ContactID |
| FOLDER (f) | FolderID |
| ROLE (role) | RoleID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/RoleMember?[f=FolderID]{&p=ProjectID}{&u=UserID}[&role=RoleID][&sharetoken=ShareTokenID][&format=IOType]
| FOLDER (f) | FolderID |
| PROJECT (p) | ProjectID |
| USER (u) | UserID |
| ROLE (role) | RoleID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
/api/rest/Search?{p=ProjectID}[&sharetoken=ShareTokenID]{&s=String}[&f=FolderID][&format=IOType]
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| SEARCH (s) | String |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/BimStory?[f=FolderID][&sharetoken=ShareTokenID][&r=BimStoryID][&tag=String][&modelversion=String][&format=IOType]{&model=Integer}{&building=Integer}
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | BimStoryID |
| TAG (tag) | String |
| MODEL_VERSION (modelversion) | String |
| FORMAT (format) | IOType |
| MODEL (model) | Integer (ID or number) |
| BUILDING (building) | Integer (ID or number) |
/api/rest/Tag?[sharetoken=ShareTokenID][&itemkey=ItemID][&format=IOType][&r=TagID][&f=FolderID][&tag=String][&customer=CustomerID]
| SHARETOKEN (sharetoken) | ShareTokenID |
| ITEMKEY (itemkey) | ItemID |
| FORMAT (format) | IOType |
| RECORD (r) | TagID |
| FOLDER (f) | FolderID |
| TAG (tag) | String |
| CUSTOMER (customer) | CustomerID |
/api/rest/Tag?{tag=String}[&sharetoken=ShareTokenID]{&itemkey=ItemID}[&f=FolderID][&format=IOType]
| TAG (tag) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| ITEMKEY (itemkey) | ItemID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
/api/rest/Tag?{itemkey=ItemID}[&f=FolderID][&format=IOType]{&r=TagID}[&sharetoken=ShareTokenID]
| ITEMKEY (itemkey) | ItemID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| RECORD (r) | TagID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/Task?[end=String][&p=ProjectID][&tag=String][&sharetoken=ShareTokenID][&r=TaskID][&active=Boolean][&start=String][&f=FolderID][&t=TaskCategory][&offset=Integer][&format=IOType][&limit=Integer]
| END (end) | String |
| PROJECT (p) | ProjectID |
| TAG (tag) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | TaskID |
| ACTIVE (active) | Boolean |
| START (start) | String |
| FOLDER (f) | FolderID |
| TYPE (t) | TaskCategory |
| OFFSET (offset) | Integer (ID or number) |
| FORMAT (format) | IOType |
| LIMIT (limit) | Integer (ID or number) |
/api/rest/ActivityInstance?[wfi_state=WorkflowInstanceStateID][&activity=ActivityID][&wfi=WorkflowInstanceID][&sharetoken=ShareTokenID][&format=IOType][&f=FolderID]
| WORKFLOW_INSTANCE_STATE (wfi_state) | WorkflowInstanceStateID |
| ACTIVITY (activity) | ActivityID |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
/api/rest/ActivityInstance?a=SETACTOR[&sharetoken=ShareTokenID]{&wfi=WorkflowInstanceID}[&actor=Integer][&f=FolderID][&format=IOType]{&activity=ActivityID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| ACTOR (actor) | Integer (ID or number) |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| ACTIVITY (activity) | ActivityID |
/api/rest/ActivityInstance?a=SETSTATE[&f=FolderID][&format=IOType]{&activity=ActivityID}{&wfi=WorkflowInstanceID}[&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| ACTIVITY (activity) | ActivityID |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("StateID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CommentAsNote"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("ObjectID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LinkToDocumentIDs"": [Integer],
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("SkipJob"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Comment"": String
}
/api/rest/Url?[format=IOType][&sharetoken=ShareTokenID][&f=FolderID][&r=Integer]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | Integer (ID or number) |
/api/rest/Url?[sharetoken=ShareTokenID]{&f=FolderID}[&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
This call requires a request payload that should look like:
}
/api/rest/Url?[format=IOType][&f=FolderID][&sharetoken=ShareTokenID]{&r=UrlID}
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | UrlID |
This call requires a request payload that should look like:
}
/api/rest/Url?[f=FolderID]{&r=UrlID}[&sharetoken=ShareTokenID][&format=IOType]
| FOLDER (f) | FolderID |
| RECORD (r) | UrlID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
pssssst don't delete me please :(
/api/rest/User?[itemkey=String][&wfi=WorkflowInstanceID][&admin=String][&activity=ActivityID][&sharetoken=ShareTokenID][&r=UserID][&actor=UserID][&role=RoleID][&f=FolderID][&tag=String][&customer=Boolean][&format=IOType][&workflow=WorkflowID][&u=UserID][&p=ProjectID]
| ITEMKEY (itemkey) | String |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| ADMIN (admin) | String |
| ACTIVITY (activity) | ActivityID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | UserID |
| ACTOR (actor) | UserID |
| ROLE (role) | RoleID |
| FOLDER (f) | FolderID |
| TAG (tag) | String |
| CUSTOMER (customer) | Boolean |
| FORMAT (format) | IOType |
| WORKFLOW (workflow) | WorkflowID |
| USER (u) | UserID |
| PROJECT (p) | ProjectID |
/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:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Password"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Username"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("VueInterfacePreferred"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Email"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("HourOfDailyOverview"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("HourOfDailyTaskOverview"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("StopTaskNotifications"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("RevisionInNameForDownload"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("UseEmailAsUsername"": boolean,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("State"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Address"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("FirstName"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("LastName"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("City"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Fax"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Mobile"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Phone"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Zip"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CountryID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Language"": int
}
/api/rest/User?[f=FolderID][&format=IOType]{&r=UserID}{&p=ProjectID}[&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| RECORD (r) | UserID |
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/User?a=SEARCH[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID][&password=String][&p=ProjectID][&u=String][&email=String]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| PASSWORD (password) | String |
| PROJECT (p) | ProjectID |
| USER (u) | String |
| EMAIL (email) | String |
/api/rest/User?a=SETACTOR[&format=IOType][&f=FolderID]{&p=ProjectID}[&sharetoken=ShareTokenID]{&r=UserID}{&actor=UserID}
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| PROJECT (p) | ProjectID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | UserID |
| ACTOR (actor) | UserID |
/api/rest/User?a=CONFIRM[&f=FolderID][&sharetoken=ShareTokenID][&password=String][&format=IOType]
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PASSWORD (password) | String |
| FORMAT (format) | IOType |
/api/rest/User?a=CHANGE_PASSWORD[&format=IOType][&sharetoken=ShareTokenID]{&password=String}{&newpassword=String}[&f=FolderID]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PASSWORD (password) | String |
| NEW_PASSWORD (newpassword) | String |
| FOLDER (f) | FolderID |
/api/rest/User?a=CHANGE_IMAGE[&image=FileID][&r=UserID][&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]
| IMAGE (image) | FileID |
| RECORD (r) | UserID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/User?a=VIEW_HELP[&sharetoken=ShareTokenID]{&category=String}[&f=FolderID]{&seq=Integer}[&format=IOType]
| SHARETOKEN (sharetoken) | ShareTokenID |
| CATEGORY (category) | String |
| FOLDER (f) | FolderID |
| SEQUENCE (seq) | Integer (ID or number) |
| FORMAT (format) | IOType |
/api/rest/User?a=TOKEN_AUTHENTICATE[&sharetoken=ShareTokenID][&format=IOType][&f=FolderID]{&token=String}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| TOKEN (token) | String |
/api/rest/UserAccessToken?[f=FolderID][&sharetoken=ShareTokenID][&format=IOType][&r=UserAccessTokenID][&tag=String]
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| RECORD (r) | UserAccessTokenID |
| TAG (tag) | String |
/api/rest/UserAccessToken?[format=IOType][&f=FolderID][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
}
/api/rest/UserAccessToken?[f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&r=UserAccessTokenID}
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | UserAccessTokenID |
/api/rest/WorkflowInstance?[offset=Integer][&o=Integer][&end=String][&r=WorkflowInstanceID][&tag=String][&sharetoken=ShareTokenID][&format=IOType][&ot=ItemType][&status=String][&start=String][&p=ProjectID][&limit=Integer][&f=FolderID]
| OFFSET (offset) | Integer (ID or number) |
| OBJECT_ID (o) | Integer (ID or number) |
| END (end) | String |
| RECORD (r) | WorkflowInstanceID |
| TAG (tag) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| OBJECT_TYPE (ot) | ItemType |
| STATUS (status) | String |
| START (start) | String |
| PROJECT (p) | ProjectID |
| LIMIT (limit) | Integer (ID or number) |
| FOLDER (f) | FolderID |
/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:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("WorkflowInstanceStatus"": WorkflowInstanceStatus,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Status"": EventStatus
}
/api/rest/WorkflowInstance?a=PRINT[&p=ProjectID]{&r=WorkflowInstanceID}{&timezone=TimeZoneID}[&sharetoken=ShareTokenID][&format=IOType][&f=FolderID]
| PROJECT (p) | ProjectID |
| RECORD (r) | WorkflowInstanceID |
| TIMEZONE (timezone) | TimeZoneID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
/api/rest/WorkflowInstance?a=CANCEL[&f=FolderID]{&r=WorkflowInstanceID}[&format=IOType][&sharetoken=ShareTokenID]
| FOLDER (f) | FolderID |
| RECORD (r) | WorkflowInstanceID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/WorkflowInstance?a=PREVIEW[&format=IOType][&f=FolderID]{&r=WorkflowInstanceID}[&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| RECORD (r) | WorkflowInstanceID |
| SHARETOKEN (sharetoken) | ShareTokenID |
/api/rest/WorkflowInstanceState?[format=IOType][&doc=DocumentID][&wfi=WorkflowInstanceID][&f=FolderID][&sharetoken=ShareTokenID][&r=WorkflowInstanceStateID]
| FORMAT (format) | IOType |
| DOCUMENT (doc) | DocumentID |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | WorkflowInstanceStateID |
/api/rest/WorkflowInstanceState?a=SETACTOR{&u=UserID}[&f=FolderID][&format=IOType][&sharetoken=ShareTokenID]{&r=WorkflowInstanceStateID}
| USER (u) | UserID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | WorkflowInstanceStateID |
/api/rest/Workflow?[activewftasks=Boolean][&r=WorkflowID][&ot=ItemType][&admin=String][&sharetoken=ShareTokenID][&p=ProjectID][&format=IOType][&status=WorkflowStatus][&f=FolderID][&wfi=WorkflowInstanceID][&tag=String]
| ACTIVE_WORKFLOW_TASKS (activewftasks) | Boolean |
| RECORD (r) | WorkflowID |
| OBJECT_TYPE (ot) | ItemType |
| ADMIN (admin) | String |
| SHARETOKEN (sharetoken) | ShareTokenID |
| PROJECT (p) | ProjectID |
| FORMAT (format) | IOType |
| STATUS (status) | WorkflowStatus |
| FOLDER (f) | FolderID |
| WORKFLOW_INSTANCE (wfi) | WorkflowInstanceID |
| TAG (tag) | String |
/api/rest/Workflow?[format=IOType]{&f=FolderID}[&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CoordinatorID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Coordinator"":
}
}
/api/rest/Workflow?[format=IOType][&f=FolderID]{&r=WorkflowID}[&viewer=Boolean][&sharetoken=ShareTokenID]
| FORMAT (format) | IOType |
| FOLDER (f) | FolderID |
| RECORD (r) | WorkflowID |
| VIEWER (viewer) | Boolean |
| SHARETOKEN (sharetoken) | ShareTokenID |
This call requires a request payload that should look like:
{
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Status"": WorkflowStatus,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("CoordinatorID"": int,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Name"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Description"": String,
"@com.google.web.bindery.autobean.shared.AutoBean$PropertyName("Coordinator"":
}
}
/api/rest/Workflow?[sharetoken=ShareTokenID][&f=FolderID][&format=IOType]{&r=WorkflowID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| RECORD (r) | WorkflowID |
/api/rest/Workflow?a=MOVE[&sharetoken=ShareTokenID][&description=String][&name=String]{&f=FolderID}[&format=IOType]{&r=WorkflowID}
| SHARETOKEN (sharetoken) | ShareTokenID |
| DESCRIPTION (description) | String |
| NAME (name) | String |
| FOLDER (f) | FolderID |
| FORMAT (format) | IOType |
| RECORD (r) | WorkflowID |
/api/rest/Workflow?a=COPY[&description=String][&format=IOType][&coordinator=RoleID]{&f=FolderID}[&sharetoken=ShareTokenID]{&r=WorkflowID}{&name=String}
| DESCRIPTION (description) | String |
| FORMAT (format) | IOType |
| COORDINATOR (coordinator) | RoleID |
| FOLDER (f) | FolderID |
| SHARETOKEN (sharetoken) | ShareTokenID |
| RECORD (r) | WorkflowID |
| NAME (name) | String |
/api/rest/Workflow?a=RELEASE[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID]{&r=WorkflowID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | WorkflowID |
/api/rest/Workflow?a=PREVIEW[&format=IOType][&sharetoken=ShareTokenID][&f=FolderID]{&r=WorkflowID}
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | WorkflowID |
/api/rest/Xref?[format=IOType][&sharetoken=ShareTokenID][&f=FolderID][&r=XrefID][&tag=String][&revision=DocumentRevisionID]
| FORMAT (format) | IOType |
| SHARETOKEN (sharetoken) | ShareTokenID |
| FOLDER (f) | FolderID |
| RECORD (r) | XrefID |
| TAG (tag) | String |
| REVISION (revision) | DocumentRevisionID |