Dela via


CMI (Preview)

For low-code based data exchange: Transfer given information from M365 directly into CMI. Transfer your data based on CMI dossier, including tasks and contacts, from M365 to the CMI solution. The CMI Custom Connector enables even more collaboration from both worlds. Their strengths combined into an unbeatable combination. With our basic functionality you can make use of almost every M365 app to create new or update given objects in your CMI solution.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name CM Informatik AG
URL http://www.cmiag.ch
Email support@cmiag.ch
Connector Metadata
Publisher CM Informatik AG
Website http://www.cmiag.ch
Privacy policy https://cmiag.ch/rechtliches/
Categories Content and Files

For low-code based data exchange: Transfer given information from M365 directly into CMI. Transfer your data based on CMI dossier, including tasks and contacts, from M365 to the CMI solution. The CMI Custom Connector enables even more collaboration from both worlds. Their strengths combined into an unbeatable combination. With our basic functionality you can make use of almost every M365 app to create new or update given objects in your CMI solution.

Prerequisites

A valid subscription to CMI Cloud.

How to get credentials

Request access by contacting CM Informatik AG Support

Get started with your connector

Create your first flow: upload document from Sharepoint to CMI. After getting all the metadata for the file you want to upload, follow this next steps:

  1. Search for the dossier where you want to upload the document with the ´Search dossiers with TentaQl syntax´ method.
  2. Create a folder and a subfolder inside the given dossier with the ´Create folder´ method.
  3. Upload the document inside the previously created folder with the ´Create new document´ method.

Known issues and limitations

N/A

Common errors and remedies

There are fields that are required even that the API doesn't explicitly say so. The error message should be indicating which is the field that is missing. Not all the subscriptions have all the endpoints available, meaning that maybe you see an action that would not work with your current subscription.

FAQ

Q: Do I need a subscription to use this connector? A: Yes, you will need an active subscription to the CMI license in order to use the CMI connector.

Q: What should I do if I have trouble using my custom connector? A: If you encounter any issues while using your custom connector, you can consult the Power Automate documentation or contact CMI support for assistance. They can help you troubleshoot any problems and ensure that your custom connector is working correctly.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Check in document

Check in document

Check out document

Check out document

Create Activity

Create Activity

Create address

Create address

Create contact

Create contact

Create folder

Create folder

Create new document

Create new document

Create new dossier

Create new dossier

Delete a folder

Delete a folder

Delete activity

Delete activity

Delete address

Delete address

Delete contact

Delete contact

Delete document

Delete document

Delete dossier

Delete dossier

Discard checked out document

Discard checked out document

Download document content

Download document content (of a specific version)

Execute an activity menu

Execute an activity menu

Get a single dossier by GUID

Get single dossier by GUID

Get Abstract Dossier by GUID

Get Abstract Dossier by GUID

Get activity by GUID

Get activity by GUID

Get address by GUID

Get address by GUID

Get contact by GUID

Get contact by GUID

Get document by GUID

Get document by GUID

Get folder by GUID

Get folder by GUID

Get person by GUID

Get person by GUID

Return Abstract Activity by GUID

Return Abstract Activity by GUID

Search Abstract Activities with the TentaQl syntax

Search Abstract Activities with the TentaQl syntax

Search Abstract Dossier with TentaQl Syntax

Search Abstract Dossier with TentaQl Syntax

Search activities with the TentaQl syntax

Search activities with the TentaQl syntax

Search addresses with the TentaQl syntax

Search addresses with the TentaQl syntax

Search contacts with the TentaQl syntax

Search contacts with the TentaQl syntax

Search documents with TentaQl syntax

Search documents with TentaQl syntax

Search dossiers with TentaQl syntax

Search dossiers with TentaQl syntax

Search folders with TentaQl syntax

Search folders with TentaQl syntax

Search persons with TentaQl syntax

Search persons with TentaQl syntax

Send an HTTP request

Construct a REST API request to invoke.

Update activity

Update activity

Update address

Update address

Update contact

Update contact

Update document

Update document

Update dossier

Update dossier

Update folder

Update folder

Check in document

Check in document

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

File
file file

File

Check In Comment
checkInComment string

Check In Comment

Document Status
dokumentStatus string

Document Status

Check out document

Check out document

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Create Activity

Create Activity

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

Path to Template
Vorlage string

Path to the object template

Activity GUID
guid uuid
Version
version integer
Type Name
typeName string
Title
titel True string
Due Date
termin string
Start Date
beginn string
Completion Date
erledigung string
Status
status True string

NochNichtBegonnen, Erfasst, InBearbeitung, Fertig, Abgeschlossen, Abgebrochen

Remark
bemerkung string
External Key
schluesselFremdsystem string
Activity Type
aktivitaetstyp string
Document GUID
guid uuid
Document Name
displayName string
Document Url
url string
Main activity GUID
guid uuid
Main activity Name
displayName string
Main activity Url
url string
Dossier GUID
guid uuid
Dossier Name
displayName string
Dossier Url
url string
From GUID
guid uuid
From Name
displayName string
From Url
url string
To GUID
guid uuid
To Name
displayName string
To Url
url string
Responsable GUID
guid uuid
Responsable Name
displayName string
Responsable Url
url string

Returns

response
uuid

Create address

Create address

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

Path to Template
Vorlage string

Path to the object template

Address GUID
guid uuid
Version
version integer
Type Name
typeName string
Street
strasse string
Postal Code
plz string
City
ort string
Inactive
inaktiv True boolean
Valid From - To
gueltigVonBis string
Contact GUID
guid uuid
Contact Name
displayName string
Contact Url
url string
Address type GUID
guid uuid
Address type Name
displayName string
Address type Url
url string
Country GUID
guid uuid
Country Name
displayName string
Country Url
url string

Returns

response
uuid

Create contact

Create contact

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

Path to Template
Vorlage string

Path to the object template

Contact GUID
guid uuid
Version number
version integer
Type name
typeName string
External Key
fremdkey string
Private phone number
telefonPrivat string
Business phone number
telefonGeschaeft string
Organization
organisation string
Mobile phone number
natel string
Birth date
geburtsdatum string
Secondary email
email2 string
Primary email
email string
Last name
name string
First name
vorname string
Salutation
anrede string
EDocument In Process At
inBearbeitungBei string
Version
version integer
File Name
fileName string
File
file string
Creator Job
creatorJob string
Inactive
inaktiv True boolean
Employee
mitarbeiter True boolean
Death date
todesdatum string
Published
istPubliziert True boolean
Google authentication configured
googleAuthKonfiguriert True boolean
Disabled
behindert True boolean
Increased need for care
erhoehterBetreuungsbedarf True boolean
Residence unknown
aufenthaltUnbekannt True boolean
Address GUID
guid uuid
Address Name
displayName string
Address Url
url string
Participation GUID
guid uuid
Participation Name
displayName string
Participation Url
url string
Correspondance Language GUID
guid uuid
Correspondance Language Name
displayName string
Correspondance Language Url
url string
Gender GUID
guid uuid
Gender Name
displayName string
Gender Url
url string
Hometowns GUID
guid uuid
Hometowns Name
displayName string
Hometowns Url
url string
Nationalities GUID
guid uuid
Nationalities Name
displayName string
Nationalities Url
url string

Returns

response
uuid

Create folder

Create folder

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

Path to Template
Vorlage string

Path to the object template

Folder GUID
guid uuid
Version number
version integer
Type name
typeName string
Title
titel True string
Parent GUID
guid uuid
Parent Name
displayName string
Parent Url
url string
Children GUID
guid uuid
Children Name
displayName string
Children Url
url string
Dossier GUID
guid uuid
Dossier Name
displayName string
Dossier Url
url string

Returns

response
uuid

Create new document

Create new document

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

Path to Template
Vorlage string

Path to the object template

Document GUID
guid uuid
Version
version integer
Type name
typeName string

Object type name

Title
titel True string
EDocument In Process At
inBearbeitungBei string
Version
version integer
File Name
fileName string
File
file string
Creator Job
creatorJob string
Document Date
dokumentdatum string
Outgoing Date
ausgangsdatum string
Ingoing Date
eingangsdatum string
Author
autor string
Remark
bemerkung string
External Key
schluesselFremdsystem string
Decission
beschuss True boolean
Decission available
beschlussvorhanden True boolean
Is Published
istPubliziert True boolean
VIP
vip True boolean
Dossier GUID
guid uuid
Dossier Name
displayName string
Dossier Url
url string
Category GUID
guid uuid
Category Name
displayName string
Category Url
url string
Folder GUID
guid uuid
Folder Name
displayName string
Folder Url
url string

Returns

response
uuid

Create new dossier

Create new dossier

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

Path to Template
Vorlage string

Path to the object template

Dossier GUID
guid uuid
Version
version integer
Type Name
typeName string
Title
titel True string
Access Control
zugriffsteuerung True string

Offen, Restriktiv

End
ende string
Start
beginn True string
Serial Number
laufnummer True string
External System Key
schluesselFremdsystem string
Lifecycle Status
lifecycleStatus True string

InBearbeitung, Abgeschlossen, Passiv, Angeboten, ZurKassationVorgesehen, Sampling, Abgeliefert, Kassiert, ZurAufbewahrungVorgesehen, Aufbewahrt, ZurKassationFreigegeben, Archiviert, KassiertAufbewahrt

Registry GUID
guid uuid
Registry Name
displayName string
Registry Url
url string
Dossier Status
geschaeftsstatus True string

InBearbeitung, Storniert, Zusammengefuehrt, Abgeschlossen

Document GUID
guid uuid
Document Name
displayName string
Document Url
url string
Activities GUID
guid uuid
Activities Name
displayName string
Activities Url
url string
Document Explorer GUID
guid uuid
Document Explorer Name
displayName string
Document Explorer Url
url string
Folder GUID
guid uuid
Folder Name
displayName string
Folder Url
url string
Business Owner GUID
guid uuid
Business Owner Name
displayName string
Business Owner Url
url string
Main dossier GUID
guid uuid
Main dossier name
displayName string
Main dossier URL
url string
Participation GUID
guid uuid
Participation Name
displayName string
Participation Url
url string
Note GUID
guid uuid
Note Name
displayName string
Note Url
url string
'Reference To' GUID
guid uuid
'Reference To' Name
displayName string
'Reference To' Url
url string
'Reference From' GUID
guid uuid
'Reference From' Name
displayName string
'Reference From' Url
url string
Subdossier GUID
guid uuid
Subdossier Name
displayName string
Subdossier Url
url string

Returns

response
uuid

Delete a folder

Delete a folder

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Delete activity

Delete activity

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Delete address

Delete address

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Delete contact

Delete contact

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Delete document

Delete document

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Delete dossier

Delete dossier

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Discard checked out document

Discard checked out document

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Returns

response
binary

Download document content

Download document content (of a specific version)

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Version
Version integer

Document version

Returns

response
binary

Execute an activity menu

Execute an activity menu

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Menu key
menu True string

Menu key

Get a single dossier by GUID

Get single dossier by GUID

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Returns

Body
Geschaeft

Get Abstract Dossier by GUID

Get Abstract Dossier by GUID

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Returns

Get activity by GUID

Get activity by GUID

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Returns

Body
Aktivitaet

Get address by GUID

Get address by GUID

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Returns

Body
Adresse

Get contact by GUID

Get contact by GUID

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Returns

Body
Kontakt

Get document by GUID

Get document by GUID

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Returns

Body
Dokument

Get folder by GUID

Get folder by GUID

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Returns

Body
Ordner

Get person by GUID

Get person by GUID

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object GUID

Returns

Body
Person

Return Abstract Activity by GUID

Return Abstract Activity by GUID

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

Object of type abstract activity GUID

Returns

Search Abstract Activities with the TentaQl syntax

Search Abstract Activities with the TentaQl syntax

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

TentaQl Query
body string

TentaQl Query

Returns

Search Abstract Dossier with TentaQl Syntax

Search Abstract Dossier with TentaQl Syntax

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

TentaQl Query
body string

TentaQl Query

Returns

Search activities with the TentaQl syntax

Search activities with the TentaQl syntax

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

TentaQl Query
body string

TentaQl Query

Returns

Search addresses with the TentaQl syntax

Search addresses with the TentaQl syntax

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

TentaQl Query
body string

TentaQl Query

Returns

response
array of Adresse

Search contacts with the TentaQl syntax

Search contacts with the TentaQl syntax

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

TentaQl Query
body string

TentaQl Query

Returns

response
array of Kontakt

Search documents with TentaQl syntax

Search documents with TentaQl syntax

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

TentaQl Query
body string

TentaQl Query

Returns

Search dossiers with TentaQl syntax

Search dossiers with TentaQl syntax

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

TentaQl Query
body string

TentaQl Query

Returns

Search folders with TentaQl syntax

Search folders with TentaQl syntax

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

TentaQl Query
body string

TentaQl Query

Returns

response
array of Ordner

Search persons with TentaQl syntax

Search persons with TentaQl syntax

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

TentaQl Query
body string

TentaQl Query

Returns

response
array of Person

Send an HTTP request

Construct a REST API request to invoke.

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

Method
method True string

Http Method

Path
path True string

Relative url after /api/proxy/ prefix. Example: AbstraktesGeschaeft/Search

Headers
headers object

Enter JSON object of request headers

Body
body string

Enter request content in JSON

Update activity

Update activity

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Activity GUID
guid uuid
Version
version integer
Type Name
typeName string
Title
titel True string
Due Date
termin string
Start Date
beginn string
Completion Date
erledigung string
Status
status True string

NochNichtBegonnen, Erfasst, InBearbeitung, Fertig, Abgeschlossen, Abgebrochen

Remark
bemerkung string
External Key
schluesselFremdsystem string
Activity Type
aktivitaetstyp string
Document GUID
guid uuid
Document Name
displayName string
Document Url
url string
Main activity GUID
guid uuid
Main activity Name
displayName string
Main activity Url
url string
Dossier GUID
guid uuid
Dossier Name
displayName string
Dossier Url
url string
From GUID
guid uuid
From Name
displayName string
From Url
url string
To GUID
guid uuid
To Name
displayName string
To Url
url string
Responsable GUID
guid uuid
Responsable Name
displayName string
Responsable Url
url string

Update address

Update address

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Address GUID
guid uuid
Version
version integer
Type Name
typeName string
Street
strasse string
Postal Code
plz string
City
ort string
Inactive
inaktiv True boolean
Valid From - To
gueltigVonBis string
Contact GUID
guid uuid
Contact Name
displayName string
Contact Url
url string
Address type GUID
guid uuid
Address type Name
displayName string
Address type Url
url string
Country GUID
guid uuid
Country Name
displayName string
Country Url
url string

Update contact

Update contact

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Contact GUID
guid uuid
Version number
version integer
Type name
typeName string
External Key
fremdkey string
Private phone number
telefonPrivat string
Business phone number
telefonGeschaeft string
Organization
organisation string
Mobile phone number
natel string
Birth date
geburtsdatum string
Secondary email
email2 string
Primary email
email string
Last name
name string
First name
vorname string
Salutation
anrede string
EDocument In Process At
inBearbeitungBei string
Version
version integer
File Name
fileName string
File
file string
Creator Job
creatorJob string
Inactive
inaktiv True boolean
Employee
mitarbeiter True boolean
Death date
todesdatum string
Published
istPubliziert True boolean
Google authentication configured
googleAuthKonfiguriert True boolean
Disabled
behindert True boolean
Increased need for care
erhoehterBetreuungsbedarf True boolean
Residence unknown
aufenthaltUnbekannt True boolean
Address GUID
guid uuid
Address Name
displayName string
Address Url
url string
Participation GUID
guid uuid
Participation Name
displayName string
Participation Url
url string
Correspondance Language GUID
guid uuid
Correspondance Language Name
displayName string
Correspondance Language Url
url string
Gender GUID
guid uuid
Gender Name
displayName string
Gender Url
url string
Hometowns GUID
guid uuid
Hometowns Name
displayName string
Hometowns Url
url string
Nationalities GUID
guid uuid
Nationalities Name
displayName string
Nationalities Url
url string

Update document

Update document

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Document GUID
guid uuid
Version
version integer
Type name
typeName string

Object type name

Title
titel True string
EDocument In Process At
inBearbeitungBei string
Version
version integer
File Name
fileName string
File
file string
Creator Job
creatorJob string
Document Date
dokumentdatum string
Outgoing Date
ausgangsdatum string
Ingoing Date
eingangsdatum string
Author
autor string
Remark
bemerkung string
External Key
schluesselFremdsystem string
Decission
beschuss True boolean
Decission available
beschlussvorhanden True boolean
Is Published
istPubliziert True boolean
VIP
vip True boolean
Dossier GUID
guid uuid
Dossier Name
displayName string
Dossier Url
url string
Category GUID
guid uuid
Category Name
displayName string
Category Url
url string
Folder GUID
guid uuid
Folder Name
displayName string
Folder Url
url string

Update dossier

Update dossier

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Dossier GUID
guid uuid
Version
version integer
Type Name
typeName string
Title
titel True string
Access Control
zugriffsteuerung True string

Offen, Restriktiv

End
ende string
Start
beginn True string
Serial Number
laufnummer True string
External System Key
schluesselFremdsystem string
Lifecycle Status
lifecycleStatus True string

InBearbeitung, Abgeschlossen, Passiv, Angeboten, ZurKassationVorgesehen, Sampling, Abgeliefert, Kassiert, ZurAufbewahrungVorgesehen, Aufbewahrt, ZurKassationFreigegeben, Archiviert, KassiertAufbewahrt

Registry GUID
guid uuid
Registry Name
displayName string
Registry Url
url string
Dossier Status
geschaeftsstatus True string

InBearbeitung, Storniert, Zusammengefuehrt, Abgeschlossen

Document GUID
guid uuid
Document Name
displayName string
Document Url
url string
Activities GUID
guid uuid
Activities Name
displayName string
Activities Url
url string
Document Explorer GUID
guid uuid
Document Explorer Name
displayName string
Document Explorer Url
url string
Folder GUID
guid uuid
Folder Name
displayName string
Folder Url
url string
Business Owner GUID
guid uuid
Business Owner Name
displayName string
Business Owner Url
url string
Main dossier GUID
guid uuid
Main dossier name
displayName string
Main dossier URL
url string
Participation GUID
guid uuid
Participation Name
displayName string
Participation Url
url string
Note GUID
guid uuid
Note Name
displayName string
Note Url
url string
'Reference To' GUID
guid uuid
'Reference To' Name
displayName string
'Reference To' Url
url string
'Reference From' GUID
guid uuid
'Reference From' Name
displayName string
'Reference From' Url
url string
Subdossier GUID
guid uuid
Subdossier Name
displayName string
Subdossier Url
url string

Update folder

Update folder

Parameters

Name Key Required Type Description
CMI Tenant
X-CMI-TENANT-NAME True string

CMI Tenant

GUID
guid True uuid

GUID from object

Folder GUID
guid uuid
Version number
version integer
Type name
typeName string
Title
titel True string
Parent GUID
guid uuid
Parent Name
displayName string
Parent Url
url string
Children GUID
guid uuid
Children Name
displayName string
Children Url
url string
Dossier GUID
guid uuid
Dossier Name
displayName string
Dossier Url
url string

Definitions

AbstrakteAktivitaet

Name Path Type Description
Abstract Activity GUID
guid uuid
Version
version integer
Type Name
typeName string
Title
titel string
Due Date
termin string
Start Date
beginn string
Completion Date
erledigung string
Status
status string

NochNichtBegonnen, Erfasst, InBearbeitung, Fertig, Abgeschlossen, Abgebrochen

Remark
bemerkung string
External Key
schluesselFremdsystem string
Activity Type
aktivitaetstyp string
dokumente
dokumente array of object
Document GUID
dokumente.guid uuid
Document Name
dokumente.displayName string
Document Url
dokumente.url string
Main activity GUID
ueberaktivitaet.guid uuid
Main activity Name
ueberaktivitaet.displayName string
Main activity Url
ueberaktivitaet.url string
Dossier GUID
geschaeft.guid uuid
Dossier Name
geschaeft.displayName string
Dossier Url
geschaeft.url string
From GUID
von.guid uuid
From Name
von.displayName string
From Url
von.url string
To GUID
an.guid uuid
To Name
an.displayName string
To Url
an.url string
Responsable GUID
anChoice.guid uuid
Responsable Name
anChoice.displayName string
Responsable Url
anChoice.url string

AbstraktesGeschaeft

Name Path Type Description
guid
guid uuid

Abstract Dossier GUID

Version
version integer
Type Name
typeName string
Title
titel string
Access Control
zugriffsteuerung string

Offen, Restriktiv

Start Date
beginn string
Completion Date
ende string
Remark
bemerkung string
Sequence Number
laufnummer string
External Key
schluesselFremdsystem string
Lifecycle Status
lifecycleStatus string

InBearbeitung, Abgeschlossen, Passiv, Angeboten, ZurKassationVorgesehen, Sampling, Abgeliefert, Kassiert, ZurAufbewahrungVorgesehen, Aufbewahrt, ZurKassationFreigegeben, Archiviert, KassiertAufbewahrt

Registry GUID
customRegistraturplan.guid uuid
Registry Name
customRegistraturplan.displayName string
Registry Url
customRegistraturplan.url string
Business Owner GUID
geschaeftseigner.guid uuid
Business Owner Name
geschaeftseigner.displayName string
Business Owner Url
geschaeftseigner.url string
Main dossier GUID
hauptDossier.guid uuid
Main dossier Name
hauptDossier.displayName string
Main dossier URL
hauptDossier.url string
dokumente
dokumente array of object
Document GUID
dokumente.guid uuid
Document Name
dokumente.displayName string
Document Url
dokumente.url string
beteiligungen
beteiligungen array of object
Participation GUID
beteiligungen.guid uuid
Participation Name
beteiligungen.displayName string
Participation Url
beteiligungen.url string
notizen
notizen array of object
Note GUID
notizen.guid uuid
Note Name
notizen.displayName string
Note Url
notizen.url string
verweisZu
verweisZu array of object
'Reference To' GUID
verweisZu.guid uuid
'Reference To' Name
verweisZu.displayName string
'Reference To' Url
verweisZu.url string
verweisVon
verweisVon array of object
'Reference From' GUID
verweisVon.guid uuid
'Reference From' Name
verweisVon.displayName string
'Reference From' Url
verweisVon.url string
subgeschaeft
subgeschaeft array of object
Subdossier GUID
subgeschaeft.guid uuid
Subdossier Name
subgeschaeft.displayName string
Subdossier Url
subgeschaeft.url string

Adresse

Name Path Type Description
Address GUID
guid uuid
Version
version integer
Type Name
typeName string
Street
strasse string
Postal Code
plz string
City
ort string
Inactive
inaktiv boolean
Valid From - To
gueltigVonBis string
Contact GUID
kontakt.guid uuid
Contact Name
kontakt.displayName string
Contact Url
kontakt.url string
Address type GUID
adressart.guid uuid
Address type Name
adressart.displayName string
Address type Url
adressart.url string
Country GUID
land.guid uuid
Country Name
land.displayName string
Country Url
land.url string

Aktivitaet

Name Path Type Description
Activity GUID
guid uuid
Version
version integer
Type Name
typeName string
Title
titel string
Due Date
termin string
Start Date
beginn string
Completion Date
erledigung string
Status
status string

NochNichtBegonnen, Erfasst, InBearbeitung, Fertig, Abgeschlossen, Abgebrochen

Remark
bemerkung string
External Key
schluesselFremdsystem string
Activity Type
aktivitaetstyp string
dokumente
dokumente array of object
Document GUID
dokumente.guid uuid
Document Name
dokumente.displayName string
Document Url
dokumente.url string
Main activity GUID
ueberaktivitaet.guid uuid
Main activity Name
ueberaktivitaet.displayName string
Main activity Url
ueberaktivitaet.url string
Dossier GUID
geschaeft.guid uuid
Dossier Name
geschaeft.displayName string
Dossier Url
geschaeft.url string
From GUID
von.guid uuid
From Name
von.displayName string
From Url
von.url string
To GUID
an.guid uuid
To Name
an.displayName string
To Url
an.url string
Responsable GUID
anChoice.guid uuid
Responsable Name
anChoice.displayName string
Responsable Url
anChoice.url string

Dokument

Name Path Type Description
Document GUID
guid uuid
Version
version integer
Type name
typeName string

Object type name

Title
titel string
eDokument
eDokument EDokument
Document Date
dokumentdatum string
Outgoing Date
ausgangsdatum string
Ingoing Date
eingangsdatum string
Author
autor string
Remark
bemerkung string
External Key
schluesselFremdsystem string
Decission
beschuss boolean
Decission available
beschlussvorhanden boolean
Is Published
istPubliziert boolean
VIP
vip boolean
Dossier GUID
geschaeft.guid uuid
Dossier Name
geschaeft.displayName string
Dossier Url
geschaeft.url string
Category GUID
kategorie.guid uuid
Category Name
kategorie.displayName string
Category Url
kategorie.url string
Folder GUID
geschaeftPosteingangExplorer.guid uuid
Folder Name
geschaeftPosteingangExplorer.displayName string
Folder Url
geschaeftPosteingangExplorer.url string

EDokument

Name Path Type Description
EDocument In Process At
inBearbeitungBei string
renditions
renditions array of Rendition

Geschaeft

Name Path Type Description
Dossier GUID
guid uuid
Version
version integer
Type Name
typeName string
Title
titel string
Access Control
zugriffsteuerung string

Offen, Restriktiv

End
ende string
Start
beginn string
Serial Number
laufnummer string
External System Key
schluesselFremdsystem string
Lifecycle Status
lifecycleStatus string

InBearbeitung, Abgeschlossen, Passiv, Angeboten, ZurKassationVorgesehen, Sampling, Abgeliefert, Kassiert, ZurAufbewahrungVorgesehen, Aufbewahrt, ZurKassationFreigegeben, Archiviert, KassiertAufbewahrt

Registry GUID
customRegistraturplan.guid uuid
Registry Name
customRegistraturplan.displayName string
Registry Url
customRegistraturplan.url string
Dossier Status
geschaeftsstatus string

InBearbeitung, Storniert, Zusammengefuehrt, Abgeschlossen

dokumente
dokumente array of object
Document GUID
dokumente.guid uuid
Document Name
dokumente.displayName string
Document Url
dokumente.url string
aktivitaeten
aktivitaeten array of object
Activities GUID
aktivitaeten.guid uuid
Activities Name
aktivitaeten.displayName string
Activities Url
aktivitaeten.url string
dokumenteExplorer
dokumenteExplorer array of object
Document Explorer GUID
dokumenteExplorer.guid uuid
Document Explorer Name
dokumenteExplorer.displayName string
Document Explorer Url
dokumenteExplorer.url string
ordner
ordner array of object
Folder GUID
ordner.guid uuid
Folder Name
ordner.displayName string
Folder Url
ordner.url string
Business Owner GUID
geschaeftseigner.guid uuid
Business Owner Name
geschaeftseigner.displayName string
Business Owner Url
geschaeftseigner.url string
Main dossier GUID
hauptDossier.guid uuid
Main dossier name
hauptDossier.displayName string
Main dossier URL
hauptDossier.url string
beteiligungen
beteiligungen array of object
Participation GUID
beteiligungen.guid uuid
Participation Name
beteiligungen.displayName string
Participation Url
beteiligungen.url string
notizen
notizen array of object
Note GUID
notizen.guid uuid
Note Name
notizen.displayName string
Note Url
notizen.url string
verweisZu
verweisZu array of object
'Reference To' GUID
verweisZu.guid uuid
'Reference To' Name
verweisZu.displayName string
'Reference To' Url
verweisZu.url string
verweisVon
verweisVon array of object
'Reference From' GUID
verweisVon.guid uuid
'Reference From' Name
verweisVon.displayName string
'Reference From' Url
verweisVon.url string
subgeschaeft
subgeschaeft array of object
Subdossier GUID
subgeschaeft.guid uuid
Subdossier Name
subgeschaeft.displayName string
Subdossier Url
subgeschaeft.url string

Kontakt

Name Path Type Description
Contact GUID
guid uuid
Version number
version integer
Type name
typeName string
External Key
fremdkey string
Private phone number
telefonPrivat string
Business phone number
telefonGeschaeft string
Organization
organisation string
Mobile phone number
natel string
Birth date
geburtsdatum string
Secondary email
email2 string
Primary email
email string
Last name
name string
First name
vorname string
Salutation
anrede string
foto
foto EDokument
Inactive
inaktiv boolean
Employee
mitarbeiter boolean
Death date
todesdatum string
Published
istPubliziert boolean
Google authentication configured
googleAuthKonfiguriert boolean
Disabled
behindert boolean
Increased need for care
erhoehterBetreuungsbedarf boolean
Residence unknown
aufenthaltUnbekannt boolean
adressen
adressen array of object
Address GUID
adressen.guid uuid
Address Name
adressen.displayName string
Address Url
adressen.url string
beteiligungen
beteiligungen array of object
Participation GUID
beteiligungen.guid uuid
Participation Name
beteiligungen.displayName string
Participation Url
beteiligungen.url string
Correspondance Language GUID
korrespondenzsprache.guid uuid
Correspondance Language Name
korrespondenzsprache.displayName string
Correspondance Language Url
korrespondenzsprache.url string
Gender GUID
geschlecht.guid uuid
Gender Name
geschlecht.displayName string
Gender Url
geschlecht.url string
heimatorte
heimatorte array of object
Hometowns GUID
heimatorte.guid uuid
Hometowns Name
heimatorte.displayName string
Hometowns Url
heimatorte.url string
nationalitaeten
nationalitaeten array of object
Nationalities GUID
nationalitaeten.guid uuid
Nationalities Name
nationalitaeten.displayName string
Nationalities Url
nationalitaeten.url string

Ordner

Name Path Type Description
Folder GUID
guid uuid
Version number
version integer
Type name
typeName string
Title
titel string
Parent GUID
parent.guid uuid
Parent Name
parent.displayName string
Parent Url
parent.url string
children
children array of object
Children GUID
children.guid uuid
Children Name
children.displayName string
Children Url
children.url string
Dossier GUID
geschaeft.guid uuid
Dossier Name
geschaeft.displayName string
Dossier Url
geschaeft.url string

Person

Name Path Type Description
Global Unique ID
guid uuid
Version number
version integer
Type name
typeName string
External key
fremdkey string
Private phone
telefonPrivat string
Business phone
telefonGeschaeft string
Organization
organisation string
Mobile phone
natel string
Birth date
geburtsdatum string
Secondary email
email2 string
Email
email string
Last name
name string
First name
vorname string
foto
foto EDokument
Salutation
anrede string
Inactive
inaktiv boolean
Employee
mitarbeiter boolean
Is published
istPubliziert boolean
Google auth configured
googleAuthKonfiguriert boolean
First name(s)
vornamen string
adressen
adressen array of object
Address GUID
adressen.guid uuid
Address Name
adressen.displayName string
Address Url
adressen.url string
Gender GUID
geschlecht.guid uuid
Gender Name
geschlecht.displayName string
Gender Url
geschlecht.url string
beteiligungen
beteiligungen array of object
Participation GUID
beteiligungen.guid uuid
Participation Name
beteiligungen.displayName string
Participation Url
beteiligungen.url string
Correspondance Language GUID
korrespondenzsprache.guid uuid
Correspondance Language Name
korrespondenzsprache.displayName string
Correspondance Language Url
korrespondenzsprache.url string
heimatorte
heimatorte array of object
Hometowns GUID
heimatorte.guid uuid
Hometowns Name
heimatorte.displayName string
Hometowns Url
heimatorte.url string
nationalitaeten
nationalitaeten array of object
Nationalities GUID
nationalitaeten.guid uuid
Nationalities Name
nationalitaeten.displayName string
Nationalities Url
nationalitaeten.url string
Computed Correspondance Address GUID
computedKorrespondenzadresse.guid uuid
Computed Correspondance Address Name
computedKorrespondenzadresse.displayName string
Computed Correspondance Address Url
computedKorrespondenzadresse.url string

Rendition

Name Path Type Description
Version
version integer
File Name
fileName string
File
file string
Creator Job
creatorJob string

uuid

binary

This is the basic data type 'binary'.