PUT
| Operation name | Request URI | Query Parameters |
|---|---|---|
| PutAddressImage | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/address/{GGUID}/image | |
| PutDocumentFile | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/document/{GGUID}/file | create-new-version,keep-checked-out,version-comment |
| PutOpportunityRecalculation | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/gwopportunitypos/recalculatevalues | |
| PutDataObject | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID} | tag-as-recently-used |
| PutDependentTypeList | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dependenttype/{null} | |
| PutDependentType | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dependenttype/{null}/{dependentDataObjectGGUID} |
POST
| Operation name | Request URI | Query Parameters |
|---|---|---|
| PostQuery | https://login.smartwe.de:443/SmartWe/rest/v6.0/query | page,entries-per-page |
| PostIcalAppointment | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/appointment/ical | foreign-edit-permission-restriction |
| PostParticipant | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/appointment/{GGUID}/participant | gguid,type |
| PostDocumentFile | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/document/file | foreign-edit-permission-restriction |
| PostEmailFile | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/emailstore/file | foreign-edit-permission-restriction |
| PostDataObject | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType} | template-gguid,tag-as-recently-used |
| PostJournalInfo | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/journalinfo | |
| PostMultipleObjects | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/records | |
| PostDependentType | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dependenttype/{null} | |
| PostDossierEntry | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dossier | gguid2,object-type2,attribute,role1,role2,link-direction,additional-field1,additional-field2 |
| PostDataObjectPermission | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/permission | right-owner-gguid,access-right,role |
| SetLastUsedRecord | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/recent | |
| PostChangePassword | https://login.smartwe.de:443/SmartWe/rest/v6.0/user/password | tenantname,username,oldpassword,newpassword |
GET
| Operation name | Request URI | Query Parameters |
|---|---|---|
| GetAllAppServers | https://login.smartwe.de:443/SmartWe/rest/v6.0/appServer | |
| GetMobileAppsTypeDefinitions | https://login.smartwe.de:443/SmartWe/rest/v6.0/apps/mobileAppsTypeDefinitions | object-types |
| CheckLogin | https://login.smartwe.de:443/SmartWe/rest/v6.0/checklogin | silent,deviceid |
| GetAllClientVersions | https://login.smartwe.de:443/SmartWe/rest/v6.0/clientVersion/full | |
| GetClientVersionsByClients | https://login.smartwe.de:443/SmartWe/rest/v6.0/clientVersion/list | client |
| LicenceCheck | https://login.smartwe.de:443/SmartWe/rest/v6.0/externalservice/{serviceId}/subscription | |
| GetCountOfGroups | https://login.smartwe.de:443/SmartWe/rest/v6.0/group/count | object-type,min-permission |
| GetListOfGroups | https://login.smartwe.de:443/SmartWe/rest/v6.0/group/full https://login.smartwe.de:443/SmartWe/rest/v6.0/group/list |
fields,object-type,min-permission,page,entries-per-page |
| GetGroup | https://login.smartwe.de:443/SmartWe/rest/v6.0/group/{GGUID} | fields |
| GetHelp | https://login.smartwe.de:443/SmartWe/rest/v6.0/help | |
| GetLanguages | https://login.smartwe.de:443/SmartWe/rest/v6.0/languages | |
| GetCurrentUsersLoginInformation | https://login.smartwe.de:443/SmartWe/rest/v6.0/loginInformation https://login.smartwe.de:443/SmartWe/rest/v6.0/user/self/loginInformation |
|
| GetMetaData | https://login.smartwe.de:443/SmartWe/rest/v6.0/metadata | object-types |
| GetCountOfResources | https://login.smartwe.de:443/SmartWe/rest/v6.0/resource/count | object-type,min-permission |
| GetListOfResources | https://login.smartwe.de:443/SmartWe/rest/v6.0/resource/full https://login.smartwe.de:443/SmartWe/rest/v6.0/resource/list |
fields,object-type,min-permission,page,entries-per-page |
| GetResource | https://login.smartwe.de:443/SmartWe/rest/v6.0/resource/{GGUID} | fields |
| GetDossierSettings | https://login.smartwe.de:443/SmartWe/rest/v6.0/settings/dossier | |
| GetGeneralSettings | https://login.smartwe.de:443/SmartWe/rest/v6.0/settings/general | |
| GetSettingsOfSmartSearch | https://login.smartwe.de:443/SmartWe/rest/v6.0/settings/smartsearch | |
| GetSmartSearch | https://login.smartwe.de:443/SmartWe/rest/v6.0/smartsearch | query,object-type,object-types,entries-per-page,page |
| GetKewordAndMessageFromSystemnews | https://login.smartwe.de:443/SmartWe/rest/v6.0/systemNews/list | customerGroup,language |
| GetExistingTags | https://login.smartwe.de:443/SmartWe/rest/v6.0/tags/list | |
| GetAddressFieldRelations | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/address/addressfieldrelations | fields |
| GetCountOfCollectionDossierOfCompany | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/address/{GGUID}/collectiondossier/count | page,entries-per-page,search |
| GetCollectionDossierOfCompany | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/address/{GGUID}/collectiondossier/full | page,entries-per-page,search |
| GetAddressImage | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/address/{GGUID}/image | width,height,max-width,max-height |
| GetVcard | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/address/{GGUID}/vcard | |
| GetAppointmentConflicts | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/appointment/conflicts | gguid,interval-start,interval-end,user-oids,fields |
| GetIcalAppointment | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/appointment/{GGUID}/ical | include-recurrence-info |
| GetCountOfParticipants | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/appointment/{GGUID}/participant/count | |
| GetListOfParticipants | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/appointment/{GGUID}/participant/full | page,entries-per-page |
| GetParticipant | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/appointment/{GGUID}/participant/{participantGGUID} | |
| GetDocumentFile | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/document/{GGUID}/file | version,lock |
| GetListOfEmailAttachments | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/emailstore/{GGUID}/attachment/list | get-inline-attachments |
| GetEmailAttachment | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/emailstore/{GGUID}/attachment/{int-identifier} | get-inline-attachments |
| GetEmailFile | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/emailstore/{GGUID}/file | html-filter |
| GetCountOfDataObjectsV3 | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/count | inserted-after,updated-after,search,team-filter,interval-start,interval-end,linked-to,linked-to-type,linked-to-attributes |
| GetDependentTypeList | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/dependenttype/list | |
| GetObjectTypeDescriptions | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/description | |
| GetDataTypeIcons | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/icon | icon-type |
| GetListV3 | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/list https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/full |
inserted-after,updated-after,search,team-filter,page,entries-per-page,fields,interval-start,interval-end,order-by,linked-to,linked-to-type,linked-to-attributes,linked-to-roles1,linked-to-roles2,has-birthday-on,is-user |
| GetMobileAppsTypeDefinition | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/mobileAppsTypeDefinition | |
| GetLastUsedRecords | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/recent/list | fields,where-string |
| GetSchema | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/schema | |
| GetStateChanges | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/statechange | entries-per-page,fields,since-journalid,since-timestamp,change-types,entity-types,record-guids |
| GetListOfTemplates | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/template/list https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/template/full |
inserted-after,updated-after,search,team-filter,page,entries-per-page,fields,interval-start,interval-end,order-by,linked-to,linked-to-type,has-birthday-on,is-user |
| GetDependentTypeObjectListForTemplate | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/template/{GGUID}/dependenttype/{null}/list https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/template/{GGUID}/dependenttype/{null}/full |
|
| GetCountOfViews | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/view/count | |
| GetListOfViews | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/view/list | page,entries-per-page,view-kind |
| GetViewEntry | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/view/{viewGGUID} | |
| GetCountForView | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/view/{viewGGUID}/count | inserted-after,updated-after,search,interval-start,interval-end |
| GetListForView | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/view/{viewGGUID}/list https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/view/{viewGGUID}/full |
inserted-after,updated-after,search,page,entries-per-page,fields,order-by,interval-start,interval-end,has-birthday-on,is-user |
| GetObject | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID} https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dependenttype/{null}/{dependentDataObjectGGUID} |
fields,include-permissions,raw-field-values,tag-as-recently-used,isfavorite,include-maxjournalid |
| GetDependentTypeObjectList | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dependenttype/{null}/list https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dependenttype/{null}/full |
inserted-after,updated-after,search,team-filter,page,entries-per-page,fields,interval-start,interval-end,order-by,linked-to,linked-to-type,linked-to-attributes |
| GetCountOfLinks | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dossier/count | |
| GetListOfLinks | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dossier/full | page,entries-per-page,object-types |
| GetDossierEntry | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dossier/{dossierGGUID} | |
| GetObjectPermissionCount | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/permission/count | |
| GetListOfPermissions | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/permission/full | page,entries-per-page |
| GetObjectPermission | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/permission/{permissionGGUID} | |
| GetCountOfUsers | https://login.smartwe.de:443/SmartWe/rest/v6.0/user/count | object-type,min-permission |
| GetListOfUsers | https://login.smartwe.de:443/SmartWe/rest/v6.0/user/full https://login.smartwe.de:443/SmartWe/rest/v6.0/user/list |
fields,object-type,min-permission,page,entries-per-page |
| GetDataObjectTypePermission | https://login.smartwe.de:443/SmartWe/rest/v6.0/user/self/dataobjecttypepermission/list | |
| GetHolidaySettingsOfUser | https://login.smartwe.de:443/SmartWe/rest/v6.0/user/self/holidaySettings | interval-start,interval-end |
| GetHolidayCountrySettingsOfUser | https://login.smartwe.de:443/SmartWe/rest/v6.0/user/self/holidaycountryinfo | |
| GetWorkingHoursOfUser | https://login.smartwe.de:443/SmartWe/rest/v6.0/user/self/workingHours | |
| GetUser | https://login.smartwe.de:443/SmartWe/rest/v6.0/user/{GGUID} https://login.smartwe.de:443/SmartWe/rest/v6.0/user/self |
fields,include-privileged-operations,include-licensed-modules |
| GetUserImage | https://login.smartwe.de:443/SmartWe/rest/v6.0/user/{GGUID}/image https://login.smartwe.de:443/SmartWe/rest/v6.0/user/self/image |
width,height |
| GetServerVersion | https://login.smartwe.de:443/SmartWe/rest/v6.0/version/server | |
| GetDocumentMetaData | https://login.smartwe.de:443/SmartWe/rest/v6.0/xreader/documents/{documentGGUID}/{documentVersion} | |
| GetPageMetaData | https://login.smartwe.de:443/SmartWe/rest/v6.0/xreader/documents/{documentGGUID}/{documentVersion}/pages/{pageId} | |
| GetImage | https://login.smartwe.de:443/SmartWe/rest/v6.0/xreader/documents/{documentGGUID}/{documentVersion}/pages/{pageId}/{imageExtension} |
DELETE
| Operation name | Request URI | Query Parameters |
|---|---|---|
| DeleteAddressImage | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/address/{GGUID}/image | |
| DeleteParticipant | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/appointment/{GGUID}/participant/{participantGGUID} | |
| DeleteObject | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID} https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dependenttype/{null}/{dependentDataObjectGGUID} |
|
| DeleteDossierEntryByObjects | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dossier/{dossierDescription} | |
| DeleteDossierEntry | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/dossier/{dossierGGUID} | |
| DeleteObjectPermission | https://login.smartwe.de:443/SmartWe/rest/v6.0/type/{dataObjectType}/{GGUID}/permission/{permissionGGUID} |
