Partager via


Gestionnaire de contenu Power Connect

Content Manager est un système de gestion de contenu d’entreprise basé sur la gouvernance conçu pour aider les agences gouvernementales, les industries réglementées et les organisations mondiales à gérer leur contenu d’entreprise de la création à la suppression. Connectez-vous au Gestionnaire de contenu pour effectuer des actions, notamment la création ou la mise à jour d’enregistrements ou d’emplacements, le chargement ou le téléchargement de fichiers électroniques, la recherche et bien plus encore. (1.0.4.757)

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Kapish Services Pty Ltd
URL https://kapish.com.au/products/power_connect/
Messagerie électronique sales@kapish.com.au
Métadonnées du connecteur
Éditeur Kapish Services Pty Ltd
Site internet https://kapish.com.au/products/power_connect/
Politique de confidentialité https://kapish.com.au/products/privacy-policy/
Catégories Données; Contenu et fichiers

Content Manager Power Connect by Kapish est un connecteur qui fournit des fonctions d’automatisation et d’intégration dans Content Manager pour simplifier la capacité de votre organisation à répondre à ses exigences en matière de gestion des informations et de gouvernance.

Conditions préalables

  • Un ServiceAPI Du Gestionnaire de contenu accessible en externe
  • Clé d’abonnement fournie par Kapish Services Pty Ltd

Pour obtenir une liste détaillée des spécifications et des exigences, ou pour plus d’informations sur la façon dont le connecteur peut aider votre organisation, veuillez contacter Kapish Services Pty Ltd

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :

OAuth (flux client confidentiel) Utiliser OAuth pour se connecter au Gestionnaire de contenu Toutes les régions Non partageable
Géré par le système Utiliser un nom d’utilisateur et un mot de passe pour se connecter au Gestionnaire de contenu Toutes les régions Non partageable
Valeur par défaut [DÉCONSEILLÉE] Cette option concerne uniquement les connexions plus anciennes sans type d’authentification explicite et est fournie uniquement pour la compatibilité descendante. Toutes les régions Non partageable

OAuth (flux client confidentiel)

ID d’authentification : OAuth

Applicable : Toutes les régions

Utiliser OAuth pour se connecter au Gestionnaire de contenu

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
Clé d’abonnement KPC securestring Clé API pour accéder à Kapish Power Connect Vrai
URL SERVICEAPI CM (par exemple, https://myserver/CMServiceAPI/) ficelle URL où votre SERVICEAPI CM peut être atteint Vrai
URL du serveur d’autorisation (par exemple, https://myserver/adfs/oauth2/token) ficelle URL permettant d’obtenir le jeton d’accès Vrai
ID de client ficelle ID client pour l’authentification Vrai
Clé secrète client securestring Clé secrète client pour l’authentification Vrai

Géré par le système

ID d’authentification : De base

Applicable : Toutes les régions

Utiliser un nom d’utilisateur et un mot de passe pour se connecter au Gestionnaire de contenu

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
Clé d’abonnement KPC securestring Clé API pour accéder à Kapish Power Connect Vrai
URL SERVICEAPI CM (par exemple, https://myserver/CMServiceAPI/) ficelle URL où votre SERVICEAPI CM peut être atteint Vrai
Nom d'utilisateur ficelle Nom d’utilisateur pour l’authentification Vrai
Mot de passe securestring Mot de passe pour l’authentification Vrai

Valeur par défaut [DÉCONSEILLÉE]

Applicable : Toutes les régions

Cette option concerne uniquement les connexions plus anciennes sans type d’authentification explicite et est fournie uniquement pour la compatibilité descendante.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
Clé d’abonnement KPC securestring Clé API pour accéder à Kapish Power Connect Vrai
URL SERVICEAPI CM (par exemple, https://myserver/CMServiceAPI/) ficelle URL où votre SERVICEAPI CM peut être atteint Vrai
URL du serveur d’autorisation (par exemple, https://myserver/adfs/oauth2/token) ficelle URL permettant d’obtenir le jeton d’accès Vrai
ID de client ficelle ID client pour l’authentification Vrai
Clé secrète client securestring Clé secrète client pour l’authentification Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Charger un fichier électronique

Charger un fichier électronique qui peut être attaché ultérieurement à un enregistrement

Créer un emplacement (autre)

Créer un emplacement de n’importe quel type

Créer un emplacement (personne)

Créer un emplacement de personne

Créer un enregistrement (avancé)

Créer un enregistrement avec des champs avancés

Créer un enregistrement (document)

Créer un enregistrement

Créer un enregistrement (dossier)

Créer un enregistrement

Lire les données d’événement

Transformer les données d’événement Kapish Dispatch pour la consommation de flux

Mettre à jour l’emplacement (adresse)

Créer /mettre à jour l’adresse d’un emplacement à l’aide de l’ID unique de l’adresse

Mettre à jour l’emplacement (autre)

Mettre à jour un emplacement

Mettre à jour l’emplacement (champs supplémentaires)

Mettre à jour des champs supplémentaires sur un emplacement

Mettre à jour l’emplacement (personne)

Mettre à jour un emplacement de personne à l’aide de son identificateur unique

Mettre à jour l’enregistrement (action ou procédure d’attachement)

Attacher une action ou une procédure à un enregistrement

Mettre à jour l’enregistrement (action réaffecter)

Réaffecte l’action nommée à un emplacement spécifié

Mettre à jour l’enregistrement (actions complètes)

Effectuer une ou toutes les actions en raison d’un enregistrement particulier

Mettre à jour l’enregistrement (actions replanifiées)

Replanifier toutes les actions attachées à cet enregistrement

Mettre à jour l’enregistrement (ajouter des contrôles d’accès)

AddAccessControl

Mettre à jour l’enregistrement (Annuler l’extraction)

Annuler une extraction précédente du document électronique pour cet enregistrement, sans tenir compte des modifications apportées depuis son extraction

Mettre à jour l’enregistrement (attacher le terme thesaurus)

Attacher un terme de dictionnaire des synonymes à un enregistrement

Mettre à jour l’enregistrement (avancé)

Mettre à jour un enregistrement avec des propriétés avancées

Mettre à jour l’enregistrement (champs supplémentaires)

Mettre à jour des champs supplémentaires sur un enregistrement

Mettre à jour l’enregistrement (classification)

Mettre à jour la classification d’un enregistrement

Mettre à jour l’enregistrement (définir l’accès illimité ou basé sur le conteneur)

InheritAccessControl

Mettre à jour l’enregistrement (définir l’étiquette utilisateur)

Autorise le paramètre d’une étiquette d’utilisateur sur un enregistrement

Mettre à jour l’enregistrement (extraction)

Définir l’état de l’enregistrement à extraire

Mettre à jour l’enregistrement (Fermer)

Utilisez la fonction CloseRecord pour fermer un conteneur : laissez la date vide si vous souhaitez que la date de fermeture soit « maintenant ». Étant donné que la fermeture d’un enregistrement peut nécessiter la mise à jour de nombreux enregistrements contenus, cette fonction valide automatiquement les modifications

Mettre à jour l’enregistrement (finalise)

Mettre à jour un brouillon d’enregistrement

Mettre à jour l’enregistrement (Joindre un contact)

Attacher un contact à un enregistrement

Mettre à jour l’enregistrement (joindre un fichier électronique)

Attacher un fichier électronique à un enregistrement

Mettre à jour l’enregistrement (Propriétés)

Mettre à jour un enregistrement

Mettre à jour l’enregistrement (remplacer les contrôles d’accès)

SetAccessControl

Mettre à jour l’enregistrement (rendu de requête)

Vous permet de créer une demande pour que le moteur de rendu automatique effectue un rendu d’un enregistrement

Mettre à jour l’enregistrement (rouvrir)

Utilisez la fonction ReopenRecord pour rouvrir un conteneur fermé. Étant donné que la nouvelle ouverture d’un enregistrement peut nécessiter la mise à jour de nombreux enregistrements contenus, cette fonction valide automatiquement les modifications

Mettre à jour l’enregistrement (Set Assignee)

Définissez le bénéficiaire sur un emplacement particulier, revenez à la page d’accueil ou inscrivez-vous comme manquant

Mettre à jour l’enregistrement (Supprimer)

Supprimer un enregistrement

Mettre à jour l’enregistrement (supprimer l’emplacement des contrôles d’accès)

RemoveAccessControl

Mettre à jour l’enregistrement (supprimer toutes les actions)

Supprime toutes les actions attachées à l’enregistrement spécifié

Mettre à jour l’enregistrement (undispose)

Rétablit l’état de l’enregistrement (et de son contenu) afin qu’il ne soit plus supprimé

Mettre à jour l’enregistrement (Unfinalise - Définir en tant que brouillon)

Mettre à jour un enregistrement finalisé en brouillon

Obtenir un fichier à partir de l’URL

Télécharger un fichier à partir d’une URL vers une zone intermédiaire à l’aide du plug-in API du service CM « GetFileFromUrl »

Rechercher des emplacements

Rechercher des emplacements (récupérer une collection Locations à l’aide d’une chaîne de recherche)

Rechercher des enregistrements

Rechercher des enregistrements (récupérer une collection d’enregistrements à l’aide d’une chaîne de recherche)

Rechercher des enregistrements (avancés)

Rechercher des enregistrements (récupérer une collection d’enregistrements à l’aide d’une chaîne de recherche). Retourne une réponse ServiceAPI de Content Manager brute.

Rechercher des objets CM

Rechercher des objets CM

Rechercher l’emplacement par ID

Récupérer un emplacement unique par ID unique ou nom

Rechercher un enregistrement par ID

Récupérer un enregistrement unique par ID unique ou nom

Rechercher un ID unique de l’adresse d’emplacement

Obtenir l’ID unique de l’adresse enfant d’un emplacement

Supprimer un enregistrement

Supprimer un enregistrement

Télécharger un fichier électronique

Télécharger un fichier électronique d’un enregistrement

Charger un fichier électronique

Charger un fichier électronique qui peut être attaché ultérieurement à un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Nom du fichier
RecordFilePath True string
Identificateur unique
Uri True string

Créer un emplacement (autre)

Créer un emplacement de n’importe quel type

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Type d’emplacement
LocationTypeOfLocation string
Nom
LocationSortName True string
Nom unique
LocationNickName string
Numéro d’ID
LocationIdNumber string
Interne
LocationIsWithin boolean
Téléphone professionel
LocationPhoneNumber string
Téléphone mobile
LocationMobileNumber string
Télécopie
LocationFaxNumber string
Téléphone personnel
LocationAfterHoursPhoneNumber string
Identique à l’adresse
LocationUseAddressOf integer

ID unique de l’emplacement

Type d’adresse
LocationAddressAddressType string

Sélectionnez le type d’adresse. Limite d’un par type.

Rue
LocationAddressAddressLines string
Banlieue / Ville
LocationAddressCity string
État
LocationAddressState string
Cp
LocationAddressPostcode string
Pays
LocationAddressCountry string
Définir la valeur par défaut
AddRelationshipMakeThisTheDefaultRelationship boolean
ID unique associé
AddRelationshipRelatedLocation integer
Type
AddRelationshipRelationshipType string
Adresse électronique
LocationEmailAddress string
De
SetActiveDateRangeValidFromDate string

dd/mm/aaaa

À
SetActiveDateRangeValidToDate string

dd/mm/aaaa

Remarques
LocationNotes string
Type de mise à jour des notes
NotesUpdateType string

Retours

Créer un emplacement (personne)

Créer un emplacement de personne

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Titre
LocationHonorific string
Nom de famille
LocationSurname string
Prénom
LocationGivenNames string
Interne
LocationIsWithin boolean
Poste
LocationJobDescription string
Date de naissance
LocationDateOfBirth string
Salutation
LocationSalutation string
Nom unique
LocationNickName string
Numéro d’ID
LocationIdNumber string
Téléphone professionel
LocationPhoneNumber string
Téléphone mobile
LocationMobileNumber string
Télécopie
LocationFaxNumber string
Téléphone personnel
LocationAfterHoursPhoneNumber string
Identique à l’adresse
LocationUseAddressOf integer

ID unique de l’emplacement

Type d’adresse
LocationAddressAddressType string

Sélectionnez le type d’adresse. Limite d’un par type.

Rue
LocationAddressAddressLines string
Banlieue / Ville
LocationAddressCity string
État
LocationAddressState string
Cp
LocationAddressPostcode string
Pays
LocationAddressCountry string
Définir la valeur par défaut
AddRelationshipMakeThisTheDefaultRelationship boolean
ID unique associé
AddRelationshipRelatedLocation integer
Type
AddRelationshipRelationshipType string
Adresse électronique
LocationEmailAddress string
Gender
LocationGenderValue string
Acceptation des connexions
LocationCanLogin boolean
Connexion réseau
LocationLogsInAs string
Connexion réseau supplémentaire
LocationAdditionalLogin string
La connexion expire le
LocationLoginExpires string
Profil utilisateur de
LocationUseProfileOf integer

ID unique de l’emplacement

Type d’utilisateur
LocationUserType string
Chaîne de sécurité
LocationSecurityString string
De
SetActiveDateRangeValidFromDate string

dd/mm/aaaa

À
SetActiveDateRangeValidToDate string

dd/mm/aaaa

Remarques
LocationNotes string
Type de mise à jour des notes
NotesUpdateType string

Retours

Créer un enregistrement (avancé)

Créer un enregistrement avec des champs avancés

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Type d’enregistrement
RecordRecordType True string
Titre (partie texte libre)
RecordTypedTitle True string
Classification
RecordClassification string

Fournir l’identificateur unique de la classification

Auteur
RecordAuthor string

ID unique ou adresse e-mail de l’emplacement

Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Numéro d’adhésion
RecordAccessionNumber string
Destinataire
RecordAddressee string

ID unique ou adresse e-mail de l’emplacement

Autre conteneur
RecordAlternativeContainer string
Assignee
RecordAssignee string

ID unique ou adresse e-mail de l’emplacement

Niveau de confiance de classification automatique
RecordAutoClassificationConfidenceLevel string
Rendu automatique au format PDF lors de l’enregistrement
RecordAutoRenderToPDFOnSave boolean
Ignorer les contrôles d’accès au type d’enregistrement
RecordBypassRecordTypeAccessControls boolean
Ignorer l’enregistrement ?
ByPassSave boolean

True pour ne pas enregistrer l’objet. L’une des utilisations suivantes consiste à définir une ou plusieurs propriétés sur un billet d’enregistrement et à renvoyer le formulaire d’entrée de données. Le formulaire d’entrée de données reflète ensuite les différentes propriétés définies sur l’enregistrement d’origine.

Modifier la position dans les favoris
ChangePositionWithinFavorites string

Lorsque vous recherchez des favoris, ils seront retournés dans cet ordre, sauf si un autre tri est utilisé.

Modifier la position dans l’étiquette de l’utilisateur
ChangePositionWithinUserLabel string

Lors de la recherche par UserLabel, ils seront retournés dans cet ordre, sauf si un autre tri est utilisé.,

Archiver en tant que
CheckinAs string

Définissez la propriété Source du document électronique.

Classe d’enregistrement
RecordClassOfRecord string
Client
RecordClient string

ID unique ou adresse e-mail de l’emplacement

Enregistrement client
RecordClientRecord string
Commentaires
comments string

Commentaires à afficher dans les notes d’enregistrement lorsque le document est chargé.

Consignation
RecordConsignment string
Objet d’envoi
RecordConsignmentObject string
Conteneur
RecordContainer string
Copier un document à partir d’un enregistrement
CopyDocumentFromRecord string

Spécifiez un ID unique pour l’enregistrement à partir duquel copier le document électronique pour cet enregistrement.

Créateur
RecordCreator string

ID unique ou adresse e-mail de l’emplacement

Date de création
RecordDateCreated string
Date d’échéance
RecordDateDue string
Date de publication
RecordDatePublished string
Date reçue
RecordDateReceived string
Editor
RecordEditor string

ID unique ou adresse e-mail de l’emplacement

Référence externe
RecordExternalReference string
Échec des avertissements ?
FailOnWarnings boolean

True pour ne pas créer/enregistrer un objet s’il existe des avertissements.

Nom de fichier dans le dossier Uploads
RecordFilePath string

Nom de fichier tel qu’il apparaît dans le dossier Uploads.

Finaliser l’enregistrement
RecordFinalizeOnSave boolean
Code-barres étranger
RecordForeignBarcode string
Emplacement GPS
RecordGpsLocation string
Emplacement de la maison
RecordHomeLocation string

ID unique de l’emplacement

Espace d’accueil
RecordHomeSpace string
Lancer un modèle
RecordInitiateTemplate string
Est placé entre deux
RecordIsEnclosed boolean
Compétence
RecordJurisdictions string
Conserver l’extrait
keepBookedOut boolean

True pour laisser l’enregistrement extrait une fois le document électronique chargé.

Date de la dernière action
RecordLastActionDate string
Nombre long
RecordLongNumber string
Rendre actif
MakeActive string

Rétablit l’état de l’enregistrement (et de son contenu) afin qu’il ne soit plus inactif. Lors du traitement du contenu, vous pouvez spécifier si la tâche doit s’arrêter si des défaillances se produisent.

Rendre inactif
MakeInactive string

Définit la dateInactive pour cet enregistrement et l’un de ses contenus. Lors du traitement du contenu, vous pouvez spécifier si la tâche doit s’arrêter si des défaillances se produisent.

Apporter une nouvelle révision
makeNewRevision boolean

True pour créer une révision avec ce document électronique false pour remplacer la révision actuelle.

Date de destruction manuelle
RecordManualDestructionDate string
Enregistrement de la matière
RecordMatterRecord string
Type de support
RecordMediaType string
Mes commentaires d’autorisation
RecordMyAuthorizationComments string
Mon autorisation est terminée
RecordMyAuthorizationComplete boolean
Mes commentaires de révision
RecordMyReviewComments string
Mon avis est terminé
RecordMyReviewComplete boolean
Vous devez disposer d’une autorisation ?
RecordNeedsAuthorization boolean
Besoin d’un examen ?
RecordNeedsReview boolean
Nouvelle règle de création de composant
RecordNewPartCreationRule string

ID unique de la règle de création de composants automatiques

Remarques
RecordNotes string
Type de mise à jour des notes
NotesUpdateType string
Autre contact
RecordOtherContact string

ID unique ou adresse e-mail de l’emplacement

Emplacement du propriétaire
RecordOwnerLocation string

ID unique ou adresse e-mail de l’emplacement

Hiérarchie de la conservation sur l’entrée de données ?
RecordPreserveHierarchyOnDataEntry boolean
Enregistrement de partie précédente
RecordPrevPartRecord string
Priority
RecordPriority string
Enregistrer un nouveau type
RecordNewType string

Conservez la valeur par défaut, sauf si vous créez une nouvelle version ou une copie de composant.

Enregistrement associé
RecordRelatedRecord string
Représentant
RecordRepresentative string
Planification de rétention
RecordRetentionSchedule string
Date de révision
RecordReviewDate string
Vérifier la date d’échéance
RecordReviewDueDate string
État de révision
RecordReviewState string
Security
RecordSecurity string
Enregistrement de série
RecordSeriesRecord string
Collection de propriétés
propertySets string

Spécifiez les jeux de propriétés en plus de ceux publiés pour être retournés par la requête.

Chaîne de requête
q string

Spécifiez ici une requête pour appliquer la mise à jour à un ensemble d’enregistrements plutôt qu’un seul (comme spécifié par l’ID unique).

Retours

Créer un enregistrement (document)

Créer un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Type d’enregistrement
RecordRecordType True string
Titre (partie texte libre)
RecordTypedTitle True string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Auteur
RecordAuthor string

ID unique ou adresse e-mail de l’emplacement

Destinataire
RecordAddressee string

ID unique ou adresse e-mail de l’emplacement

Autre conteneur
RecordAlternativeContainer string
Assignee
RecordAssignee string

ID unique ou adresse e-mail de l’emplacement

Rendu automatique au format PDF lors de l’enregistrement
RecordAutoRenderToPDFOnSave boolean
Ignorer les contrôles d’accès au type d’enregistrement
RecordBypassRecordTypeAccessControls boolean
Archiver en tant que
CheckinAs string

Définissez la propriété Source du document électronique.

Classification
RecordClassification string

Fournir l’identificateur unique de la classification

Client
RecordClient string

ID unique ou adresse e-mail de l’emplacement

Enregistrement client
RecordClientRecord string
Conteneur
RecordContainer string
Copier un document à partir d’un enregistrement
CopyDocumentFromRecord string

Spécifiez un ID unique pour l’enregistrement à partir duquel copier le document électronique pour cet enregistrement.

Créateur
RecordCreator string

ID unique ou adresse e-mail de l’emplacement

Date de création
RecordDateCreated string
Date d’échéance
RecordDateDue string
Date de publication
RecordDatePublished string
Date reçue
RecordDateReceived string
Référence externe
RecordExternalReference string
Échec des avertissements ?
FailOnWarnings boolean

True pour ne pas créer/enregistrer un objet s’il existe des avertissements.

Nom de fichier dans le dossier Uploads
RecordFilePath string

Nom de fichier tel qu’il apparaît dans le dossier Uploads.

Finaliser l’enregistrement
RecordFinalizeOnSave boolean
Code-barres étranger
RecordForeignBarcode string
Emplacement GPS
RecordGpsLocation string
Emplacement de la maison
RecordHomeLocation string

ID unique de l’emplacement

Espace d’accueil
RecordHomeSpace string
Est placé entre deux
RecordIsEnclosed boolean
Compétence
RecordJurisdictions string
Conserver l’extrait
keepBookedOut boolean

True pour laisser l’enregistrement extrait une fois le document électronique chargé.

Date de la dernière action
RecordLastActionDate string
Nombre long
RecordLongNumber string
Type de support
RecordMediaType string
Remarques
RecordNotes string
Type de mise à jour des notes
NotesUpdateType string
Autre contact
RecordOtherContact string

ID unique ou adresse e-mail de l’emplacement

Emplacement du propriétaire
RecordOwnerLocation string

ID unique ou adresse e-mail de l’emplacement

Enregistrement associé
RecordRelatedRecord string
Représentant
RecordRepresentative string

ID unique ou adresse e-mail de l’emplacement

Date de révision
RecordReviewDate string
Vérifier la date d’échéance
RecordReviewDueDate string
État de révision
RecordReviewState string
Security
RecordSecurity string

Retours

Créer un enregistrement (dossier)

Créer un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Type d’enregistrement
RecordRecordType True string
Titre (partie texte libre)
RecordTypedTitle True string
Classification
RecordClassification string

Fournir l’identificateur unique de la classification

Conteneur
RecordContainer string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Auteur
RecordAuthor string

ID unique ou adresse e-mail de l’emplacement

Destinataire
RecordAddressee string

ID unique ou adresse e-mail de l’emplacement

Autre conteneur
RecordAlternativeContainer string
Assignee
RecordAssignee string

ID unique ou adresse e-mail de l’emplacement

Ignorer les contrôles d’accès au type d’enregistrement
RecordBypassRecordTypeAccessControls boolean
Client
RecordClient string

ID unique ou adresse e-mail de l’emplacement

Créateur
RecordCreator string

ID unique ou adresse e-mail de l’emplacement

Date de création
RecordDateCreated string
Date d’échéance
RecordDateDue string
Date de publication
RecordDatePublished string
Référence externe
RecordExternalReference string
Échec des avertissements ?
FailOnWarnings boolean

True pour ne pas créer/enregistrer un objet s’il existe des avertissements.

Nom de fichier dans le dossier Uploads
RecordFilePath string

Nom de fichier tel qu’il apparaît dans le dossier Uploads.

Code-barres étranger
RecordForeignBarcode string
Emplacement GPS
RecordGpsLocation string
Emplacement de la maison
RecordHomeLocation string

ID unique de l’emplacement

Espace d’accueil
RecordHomeSpace string
Est placé entre deux
RecordIsEnclosed boolean
Compétence
RecordJurisdictions string
Date de la dernière action
RecordLastActionDate string
Nombre long
RecordLongNumber string
Remarques
RecordNotes string
Type de mise à jour des notes
NotesUpdateType string
Autre contact
RecordOtherContact string

ID unique ou adresse e-mail de l’emplacement

Emplacement du propriétaire
RecordOwnerLocation string

ID unique ou adresse e-mail de l’emplacement

Enregistrement associé
RecordRelatedRecord string
Représentant
RecordRepresentative string

ID unique ou adresse e-mail de l’emplacement

Date de révision
RecordReviewDate string
Vérifier la date d’échéance
RecordReviewDueDate string
État de révision
RecordReviewState string
Security
RecordSecurity string

Retours

Lire les données d’événement

Transformer les données d’événement Kapish Dispatch pour la consommation de flux

Paramètres

Nom Clé Obligatoire Type Description
Content
Content string

Contenu de l’action Service Bus qui a récupéré les données d’événement CM

Retours

Corps
CMEventData

Mettre à jour l’emplacement (adresse)

Créer /mettre à jour l’adresse d’un emplacement à l’aide de l’ID unique de l’adresse

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer

URI de l’emplacement existant à mettre à jour

ID unique
Uri integer

URI de l’adresse postale ou postale existante à mettre à jour

Type
LocationAddressAddressType string

Sélectionnez le type d’adresse. Limite d’un par type.

Rue
LocationAddressAddressLines string
Banlieue / Ville
LocationAddressCity string
État
LocationAddressState string
Cp
LocationAddressPostcode string
Pays
LocationAddressCountry string

Retours

Mettre à jour l’emplacement (autre)

Mettre à jour un emplacement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri integer
Chaîne de requête
q string

Spécifiez ici une requête pour appliquer la mise à jour à un ensemble d’emplacements plutôt qu’un seul (comme spécifié par l’ID unique).

Nom
LocationSortName string
Nom unique
LocationNickName string
Numéro d’ID
LocationIdNumber string
Téléphone professionel
LocationPhoneNumber string
Téléphone mobile
LocationMobileNumber string
Télécopie
LocationFaxNumber string
Téléphone personnel
LocationAfterHoursPhoneNumber string
Identique à l’adresse
LocationUseAddressOf integer

ID unique de l’emplacement

Définir la valeur par défaut
AddRelationshipMakeThisTheDefaultRelationship boolean
ID unique associé
AddRelationshipRelatedLocation integer
Type
AddRelationshipRelationshipType string
Adresse électronique
LocationEmailAddress string
De
SetActiveDateRangeValidFromDate string

dd/mm/aaaa

À
SetActiveDateRangeValidToDate string

dd/mm/aaaa

Remarques
LocationNotes string
Type de mise à jour des notes
NotesUpdateType string
ID unique associé
RemoveRelationshipRelatedLocation integer

Retours

Mettre à jour l’emplacement (champs supplémentaires)

Mettre à jour des champs supplémentaires sur un emplacement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri integer
Nom
SearchClause string
Valeur
Value string

Retours

Mettre à jour l’emplacement (personne)

Mettre à jour un emplacement de personne à l’aide de son identificateur unique

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri integer
Chaîne de requête
q string

Spécifiez ici une requête pour appliquer la mise à jour à un ensemble d’emplacements plutôt qu’un seul (comme spécifié par l’ID unique).

Titre
LocationHonorific string
Nom de famille
LocationSurname string
Prénom
LocationGivenNames string
Interne
LocationIsWithin boolean
Poste
LocationJobDescription string
Date de naissance
LocationDateOfBirth string
Salutation
LocationSalutation string
Nom unique
LocationNickName string
Numéro d’ID
LocationIdNumber string
Téléphone professionel
LocationPhoneNumber string
Téléphone mobile
LocationMobileNumber string
Télécopie
LocationFaxNumber string
Téléphone personnel
LocationAfterHoursPhoneNumber string
Identique à l’adresse
LocationUseAddressOf integer

ID unique de l’emplacement

Définir la valeur par défaut
AddRelationshipMakeThisTheDefaultRelationship boolean
ID unique associé
AddRelationshipRelatedLocation integer
Type
AddRelationshipRelationshipType string
Adresse électronique
LocationEmailAddress string
Gender
LocationGenderValue string
Acceptation des connexions
LocationCanLogin boolean
Connexion réseau
LocationLogsInAs string
Connexion réseau supplémentaire
LocationAdditionalLogin string
La connexion expire le
LocationLoginExpires string
Profil utilisateur de
LocationUseProfileOf integer

ID unique de l’emplacement

Type d’utilisateur
LocationUserType string
Chaîne de sécurité
LocationSecurityString string
De
SetActiveDateRangeValidFromDate string

dd/mm/aaaa

À
SetActiveDateRangeValidToDate string

dd/mm/aaaa

Remarques
LocationNotes string
Type de mise à jour des notes
NotesUpdateType string
ID unique associé
RemoveRelationshipRelatedLocation integer

Retours

Mettre à jour l’enregistrement (action ou procédure d’attachement)

Attacher une action ou une procédure à un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Action à attacher
ActionToAttach True integer
ID unique du bénéficiaire
NewAssignee integer
Assignee Option
AssigneeOption string
Date de début de la planification
ScheduleStartDate date
Action existante
RecordAction integer
Insérer une position
InsertPos string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (action réaffecter)

Réaffecte l’action nommée à un emplacement spécifié

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Nouveau bénéficiaire
NewAssignee True string

ID unique ou adresse e-mail du nouveau bénéficiaire

Action à réaffecter
RecordActionUri True integer
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (actions complètes)

Effectuer une ou toutes les actions en raison d’un enregistrement particulier

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Terminé
Complete True string

Spécifier les actions d’enregistrement à effectuer

Terminer les actions précédentes
CompletePrevious boolean

Effectuer toutes les actions d’enregistrement avant celle spécifiée

Date d’achèvement
CompletionDate date

Date à définir comme date d’achèvement

ID unique de l’action d’enregistrement
RecordActionUri integer

ID unique de l’action d’enregistrement à terminer si l’option « Identificateur unique » est sélectionnée

Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (actions replanifiées)

Replanifier toutes les actions attachées à cet enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
À partir de la date de base
FromBaseDate date
Utiliser les durées réelles
UseActualDurations boolean
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (ajouter des contrôles d’accès)

AddAccessControl

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique
Uri True integer
FunctionEnum
FunctionEnum string
ID unique
Uri integer

Identificateur unique d’emplacement

Retours

Mettre à jour l’enregistrement (Annuler l’extraction)

Annuler une extraction précédente du document électronique pour cet enregistrement, sans tenir compte des modifications apportées depuis son extraction

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Commentaires
Comments string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (attacher le terme thesaurus)

Attacher un terme de dictionnaire des synonymes à un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Enregistrement
Uri True integer

ID unique de l’enregistrement à laquelle attacher le terme du dictionnaire des synonymes

Terme du dictionnaire des synonymes
Keyword True string

ID unique ou nom du terme de dictionnaire des synonymes à attacher

Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (avancé)

Mettre à jour un enregistrement avec des propriétés avancées

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Type d’enregistrement
RecordRecordType string
Classification
RecordClassification string

Fournir l’identificateur unique de la classification

Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Auteur
RecordAuthor string

ID unique ou adresse e-mail de l’emplacement

Numéro d’adhésion
RecordAccessionNumber string
Destinataire
RecordAddressee string

ID unique ou adresse e-mail de l’emplacement

Autre conteneur
RecordAlternativeContainer string
Assignee
RecordAssignee string

ID unique ou adresse e-mail de l’emplacement

Niveau de confiance de classification automatique
RecordAutoClassificationConfidenceLevel string
Rendu automatique au format PDF lors de l’enregistrement
RecordAutoRenderToPDFOnSave boolean
Ignorer les contrôles d’accès au type d’enregistrement
RecordBypassRecordTypeAccessControls boolean
Ignorer l’enregistrement ?
ByPassSave boolean

True pour ne pas enregistrer l’objet. L’une des utilisations suivantes consiste à définir une ou plusieurs propriétés sur un billet d’enregistrement et à renvoyer le formulaire d’entrée de données. Le formulaire d’entrée de données reflète ensuite les différentes propriétés définies sur l’enregistrement d’origine.

Modifier la position dans les favoris
ChangePositionWithinFavorites string

Lorsque vous recherchez des favoris, ils seront retournés dans cet ordre, sauf si un autre tri est utilisé.

Modifier la position dans l’étiquette de l’utilisateur
ChangePositionWithinUserLabel string

Lors de la recherche par UserLabel, ils seront retournés dans cet ordre, sauf si un autre tri est utilisé.,

Archiver en tant que
CheckinAs string

Définissez la propriété Source du document électronique.

Classe d’enregistrement
RecordClassOfRecord string
Client
RecordClient string

ID unique ou adresse e-mail de l’emplacement

Enregistrement client
RecordClientRecord string
Commentaires
comments string

Commentaires à afficher dans les notes d’enregistrement lorsque le document est chargé.

Consignation
RecordConsignment string
Objet d’envoi
RecordConsignmentObject string
Conteneur
RecordContainer string
Copier un document à partir d’un enregistrement
CopyDocumentFromRecord string

Spécifiez un ID unique pour l’enregistrement à partir duquel copier le document électronique pour cet enregistrement.

Créateur
RecordCreator string

ID unique ou adresse e-mail de l’emplacement

Date de création
RecordDateCreated string
Date d’échéance
RecordDateDue string
Date de publication
RecordDatePublished string
Date reçue
RecordDateReceived string
Editor
RecordEditor string

ID unique ou adresse e-mail de l’emplacement

Magasin de documents électroniques
RecordEStore string
Référence externe
RecordExternalReference string
Échec des avertissements ?
FailOnWarnings boolean

True pour ne pas créer/enregistrer un objet s’il existe des avertissements.

Nom de fichier dans le dossier Uploads
RecordFilePath string

Nom de fichier tel qu’il apparaît dans le dossier Uploads.

Finaliser l’enregistrement
RecordFinalizeOnSave boolean
Code-barres étranger
RecordForeignBarcode string
Emplacement GPS
RecordGpsLocation string
Emplacement de la maison
RecordHomeLocation string

ID unique de l’emplacement

Espace d’accueil
RecordHomeSpace string
Est placé entre deux
RecordIsEnclosed boolean
Compétence
RecordJurisdictions string
Conserver l’extrait
keepBookedOut boolean

True pour laisser l’enregistrement extrait une fois le document électronique chargé.

Date de la dernière action
RecordLastActionDate string
Nombre long
RecordLongNumber string
Rendre actif
MakeActive string

Rétablit l’état de l’enregistrement (et de son contenu) afin qu’il ne soit plus inactif. Lors du traitement du contenu, vous pouvez spécifier si la tâche doit s’arrêter si des défaillances se produisent.

Rendre inactif
MakeInactive string

Définit la dateInactive pour cet enregistrement et l’un de ses contenus. Lors du traitement du contenu, vous pouvez spécifier si la tâche doit s’arrêter si des défaillances se produisent.

Apporter une nouvelle révision
makeNewRevision boolean

True pour créer une révision avec ce document électronique false pour remplacer la révision actuelle.

Date de destruction manuelle
RecordManualDestructionDate string
Enregistrement de la matière
RecordMatterRecord string
Type de support
RecordMediaType string
Mes commentaires d’autorisation
RecordMyAuthorizationComments string
Mon autorisation est terminée
RecordMyAuthorizationComplete boolean
Mes commentaires de révision
RecordMyReviewComments string
Mon avis est terminé
RecordMyReviewComplete boolean
Vous devez disposer d’une autorisation ?
RecordNeedsAuthorization boolean
Besoin d’un examen ?
RecordNeedsReview boolean
Nouvelle règle de création de composant
RecordNewPartCreationRule string

ID unique de la règle de création de composants automatiques

Remarques
RecordNotes string
Type de mise à jour des notes
NotesUpdateType string
Autre contact
RecordOtherContact string

ID unique ou adresse e-mail de l’emplacement

Emplacement du propriétaire
RecordOwnerLocation string

ID unique ou adresse e-mail de l’emplacement

Hiérarchie de la conservation sur l’entrée de données ?
RecordPreserveHierarchyOnDataEntry boolean
Enregistrement de partie précédente
RecordPrevPartRecord string
Priority
RecordPriority string
Enregistrer un nouveau type
RecordNewType string

Conservez la valeur par défaut, sauf si vous créez une nouvelle version ou une copie de composant.

Enregistrement associé
RecordRelatedRecord string
Représentant
RecordRepresentative string
Planification de rétention
RecordRetentionSchedule string
Date de révision
RecordReviewDate string
Vérifier la date d’échéance
RecordReviewDueDate string
État de révision
RecordReviewState string
Security
RecordSecurity string
Enregistrement de série
RecordSeriesRecord string
Titre (partie texte libre)
RecordTypedTitle string
Chaîne de requête
q string

Spécifiez ici une requête pour appliquer la mise à jour à un ensemble d’enregistrements plutôt qu’un seul (comme spécifié par l’ID unique).

Retours

Mettre à jour l’enregistrement (champs supplémentaires)

Mettre à jour des champs supplémentaires sur un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri integer
Nom
SearchClause string
Valeur
Value string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (classification)

Mettre à jour la classification d’un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Classification
RecordClassification True string

Fournir l’identificateur unique de la classification

Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (définir l’accès illimité ou basé sur le conteneur)

InheritAccessControl

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique
Uri True integer
FunctionEnum
FunctionEnum string
ID unique
Uri integer

Identificateur unique d’emplacement

Retours

Mettre à jour l’enregistrement (définir l’étiquette utilisateur)

Autorise le paramètre d’une étiquette d’utilisateur sur un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Enregistrement
Uri True integer

ID unique de l’enregistrement à joindre à l’étiquette de l’utilisateur

Étiquette de l’utilisateur
UserLabel True string

ID unique ou nom de l’étiquette d’utilisateur à appliquer

Type favori
FavouriteType string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (extraction)

Définir l’état de l’enregistrement à extraire

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Commentaires
Comments string
Enregistrer le chemin d’accès à l’extraction sous
SaveCheckoutPathAs string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (Fermer)

Utilisez la fonction CloseRecord pour fermer un conteneur : laissez la date vide si vous souhaitez que la date de fermeture soit « maintenant ». Étant donné que la fermeture d’un enregistrement peut nécessiter la mise à jour de nombreux enregistrements contenus, cette fonction valide automatiquement les modifications

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Continuez sur l’erreur ?
ContinueOnError boolean
Placer le contenu ?
EncloseContents boolean
Finaliser le contenu ?
FinalizeContents boolean
Journaliser les erreurs uniquement ?
LogErrorsOnly boolean
Résultats du journal ?
LogResults boolean

Retournez un journal texte des enregistrements fermés dans la propriété Message du journal ?

Vider les révisions de contenu ?
PurgeContentRevisions boolean
Date de fermeture spécifique ?
SpecificCloseDate date
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (finalise)

Mettre à jour un brouillon d’enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Supprimer les anciennes révisions
SetAsFinalRemoveOldRevisions boolean
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (Joindre un contact)

Attacher un contact à un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Contact Type
ContactType True string
Emplacement du contact
ContactLocation True string

ID unique ou adresse e-mail de l’emplacement

Définir comme contact principal ?
IsPrimary True boolean
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (joindre un fichier électronique)

Attacher un fichier électronique à un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Fichier
File True file

Contenu/corps du fichier du document électronique à joindre

Identificateur unique
Uri True string

ID unique de l’enregistrement

Retours

Mettre à jour l’enregistrement (Propriétés)

Mettre à jour un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri integer
Query
q string

Spécifiez ici une requête pour appliquer la mise à jour à un ensemble d’enregistrements plutôt qu’à un seul (comme spécifié par l’ID unique)

Titre (partie texte libre)
RecordTypedTitle string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Auteur
RecordAuthor string

ID unique ou adresse e-mail de l’emplacement

Conteneur
RecordContainer string
Classification
RecordClassification string

Fournir l’identificateur unique de la classification

Destinataire
RecordAddressee string

ID unique ou adresse e-mail de l’emplacement

Autre conteneur
RecordAlternativeContainer string
Assignee
RecordAssignee string

ID unique ou adresse e-mail de l’emplacement

Rendu automatique au format PDF lors de l’enregistrement
RecordAutoRenderToPDFOnSave boolean
Ignorer les contrôles d’accès au type d’enregistrement
RecordBypassRecordTypeAccessControls boolean
Archiver en tant que
CheckinAs string

Définissez la propriété Source du document électronique.

Client
RecordClient string

ID unique ou adresse e-mail de l’emplacement

Enregistrement client
RecordClientRecord string
Copier un document à partir d’un enregistrement
CopyDocumentFromRecord string

Spécifiez un ID unique pour l’enregistrement à partir duquel copier le document électronique pour cet enregistrement.

Créateur
RecordCreator string

ID unique ou adresse e-mail de l’emplacement

Date de création
RecordDateCreated string
Date d’échéance
RecordDateDue string
Date de publication
RecordDatePublished string
Date reçue
RecordDateReceived string
Référence externe
RecordExternalReference string
Échec des avertissements ?
FailOnWarnings boolean

True pour ne pas créer/enregistrer un objet s’il existe des avertissements.

Nom de fichier dans le dossier Uploads
RecordFilePath string

Nom de fichier tel qu’il apparaît dans le dossier Uploads.

Finaliser l’enregistrement
RecordFinalizeOnSave boolean
Code-barres étranger
RecordForeignBarcode string
Emplacement GPS
RecordGpsLocation string
Emplacement de la maison
RecordHomeLocation string

ID unique de l’emplacement

Espace d’accueil
RecordHomeSpace string
Est placé entre deux
RecordIsEnclosed boolean
Compétence
RecordJurisdictions string
Conserver l’extrait
keepBookedOut boolean

True pour laisser l’enregistrement extrait une fois le document électronique chargé.

Nombre long
RecordLongNumber string
Type de support
RecordMediaType string
Remarques
RecordNotes string
Type de mise à jour des notes
NotesUpdateType string
Autre contact
RecordOtherContact string

ID unique ou adresse e-mail de l’emplacement

Emplacement du propriétaire
RecordOwnerLocation string

ID unique ou adresse e-mail de l’emplacement

Enregistrement associé
RecordRelatedRecord string
Représentant
RecordRepresentative string
Date de révision
RecordReviewDate string
Vérifier la date d’échéance
RecordReviewDueDate string
État de révision
RecordReviewState string
Security
RecordSecurity string

Retours

Mettre à jour l’enregistrement (remplacer les contrôles d’accès)

SetAccessControl

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique
Uri True integer
FunctionEnum
FunctionEnum string
ID unique
Uri integer

Identificateur unique d’emplacement

Retours

Mettre à jour l’enregistrement (rendu de requête)

Vous permet de créer une demande pour que le moteur de rendu automatique effectue un rendu d’un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Type de rendu
RenditionType True string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (rouvrir)

Utilisez la fonction ReopenRecord pour rouvrir un conteneur fermé. Étant donné que la nouvelle ouverture d’un enregistrement peut nécessiter la mise à jour de nombreux enregistrements contenus, cette fonction valide automatiquement les modifications

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Continuez sur l’erreur ?
ContinueOnError boolean
Résultats du journal ?
LogResults boolean

Retournez un journal texte des enregistrements rouverts dans la propriété Message du journal ?

Annuler la définition du contenu ?
UnfinalizeContents boolean
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (Set Assignee)

Définissez le bénéficiaire sur un emplacement particulier, revenez à la page d’accueil ou inscrivez-vous comme manquant

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Nouveau bénéficiaire
NewAssignee string

ID unique ou adresse e-mail du nouveau bénéficiaire

Type de bénéficiaire
AssigneeType string
Échéance du retour par date
DueForReturnByDate date
Changement de temps réel s’est produit
ActualTimeChangeOccurred date-time
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (Supprimer)

Supprimer un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Continuez sur l’erreur ?
ContinueOnError boolean
Méthode d’élimination
MethodOfDisposal string
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (supprimer l’emplacement des contrôles d’accès)

RemoveAccessControl

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique
Uri True integer
FunctionEnum
FunctionEnum string
ID unique
Uri integer

Identificateur unique d’emplacement

Retours

Mettre à jour l’enregistrement (supprimer toutes les actions)

Supprime toutes les actions attachées à l’enregistrement spécifié

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (undispose)

Rétablit l’état de l’enregistrement (et de son contenu) afin qu’il ne soit plus supprimé

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer
Continuez sur l’erreur ?
ContinueOnError boolean
Propriétés
Properties string

Liste délimitée par des virgules de propriétés à retourner

Retours

Mettre à jour l’enregistrement (Unfinalise - Définir en tant que brouillon)

Mettre à jour un enregistrement finalisé en brouillon

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer

Retours

Obtenir un fichier à partir de l’URL

Télécharger un fichier à partir d’une URL vers une zone intermédiaire à l’aide du plug-in API du service CM « GetFileFromUrl »

Paramètres

Nom Clé Obligatoire Type Description
URL du fichier
url True string

URL non codée du fichier à télécharger

Nom de fichier à enregistrer sous
filename string

Nom de fichier pour enregistrer l’URL téléchargée en tant que (seul le nom de fichier avec suffixe, n’incluez pas le répertoire complet)

Type de contenu
contentType string

Chaîne classique trouvée dans la plupart des en-têtes Content-Type (par exemple, image/png, text/plain, application/pdf).

Retours

Réponse du plug-in API du service CM « GetFileFromUrl ».

Rechercher des emplacements

Rechercher des emplacements (récupérer une collection Locations à l’aide d’une chaîne de recherche)

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Query
q True string

Entrez une requête de recherche, par exemple « all » pour obtenir tous les objets.

Appliquer les valeurs par défaut
ApplyDefaults boolean

True pour appliquer le filtre par défaut de l’utilisateur et trier à cette recherche

Nombre de résultats
CountResults boolean

True pour inclure un nombre de résultats

Nombre d’exclusions
ExcludeCount boolean

True pour exclure un nombre de résultats

Filter
filter string

Liste séparée par un espace des clauses de recherche à appliquer en tant que filtre.

Retourné par la recherche
fromSearch string

ID unique d’une recherche enregistrée à partir de laquelle construire cette recherche

Propriétés descendantes
descendantProperties string

Une liste séparée par des virgules des propriétés d’objet s’applique uniquement aux propriétés d’objet de cette propriété de niveau inférieur, par exemple RecordNumber,RecordTitle

Inclure des définitions de propriétés
IncludePropertyDefs boolean

True pour retourner un tableau des définitions de propriétés utilisées par les propriétés dans cette réponse

Options
Options string

Définissez une ou plusieurs des options généralement définies dans Options utilisateur pour cette recherche uniquement. Utilisez des ID à partir de /PropertyDef ? Get=SearchOptions service, ajoutez un signe moins à définir sur false, sinon true est supposé.

Propriétés
properties string

Liste séparée par des virgules des propriétés d’objet, par exemple RecordNumber,RecordTitle

Collection de propriétés
propertySets string

Un ou plusieurs ensembles de propriétés prédéfinis, sélectionnez à partir de DataGridVisible, Détaillé, FromSearch, All ou un jeu de propriétés personnalisé tel que défini dans votre configuration de service

Valeur de propriété
PropertyValue string

Inclure la valeur brute, la valeur de chaîne ou les deux dans les résultats

Taille de page
pageSize string

Nombre d’éléments à retourner dans chaque page de résultats

Objectif
purpose string

Propriété spéciale pour filtrer les résultats de recherche en fonction des valeurs d’énumération d’objet Purpose

Objectif supplémentaire
purposeExtra string

Nécessaire en tant que supplément à certaines fins. Le service ObjectDef fournit des informations sur l’énumération ou le type TrimMainObject à spécifier, en particulier ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes et HaveExtraPurposeParameter.

Trier par
sortBy string

Liste séparée par des virgules des ID de clause de recherche

Démarrer
start string

Position du jeu de résultats pour démarrer, vide (ou 1) pour commencer au début, 2 pour démarrer au deuxième objet, 3 au troisième, etc.

Type d’affichage de chaîne
stringDisplayType string

Si vous retournez la valeur de chaîne au format à utiliser

Retours

Rechercher des enregistrements

Rechercher des enregistrements (récupérer une collection d’enregistrements à l’aide d’une chaîne de recherche)

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Query
q True string

Requête de recherche

Propriétés
properties True string

Liste séparée par des virgules des propriétés à retourner

Retours

Rechercher des enregistrements (avancés)

Rechercher des enregistrements (récupérer une collection d’enregistrements à l’aide d’une chaîne de recherche). Retourne une réponse ServiceAPI de Content Manager brute.

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Query
q True string

Requête de recherche

Propriétés
properties True string

Liste séparée par des virgules des propriétés à retourner

Retours

response
object

Rechercher des objets CM

Rechercher des objets CM

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Rechercher
TrimType True string
Chaîne de requête
q True string

Entrez une requête de recherche, par exemple « all » pour obtenir tous les objets.

Appliquer les valeurs par défaut
ApplyDefaults boolean

True pour appliquer le filtre par défaut de l’utilisateur et trier à cette recherche.

Nombre de résultats
CountResults boolean

CountResults retourne le nombre le plus fiable et le plus lent des résultats de recherche totaux. Le nombre obtenu se trouve dans la propriété Response Count.

Propriétés descendantes
DescendantProperties string

Une liste séparée par des virgules des propriétés d’objet s’applique uniquement aux propriétés d’objet de cette propriété de niveau inférieur, par exemple RecordNumber,RecordTitle.

Nombre d’exclusions
ExcludeCount boolean

Le renvoi de TotalResults et searchTitle peut dégrader les performances. Défini sur true si TotalResults et SearchTitle ne sont pas obligatoires.

Filter
Filter string

Liste séparée par un espace des clauses de recherche à appliquer en tant que filtre.

Retourné par la recherche
FromSearch integer

ID unique d’une recherche enregistrée à partir de laquelle construire cette recherche.

Include, propriété Defs
IncludePropertyDefs boolean

True pour retourner un tableau des définitions de propriétés utilisées par les propriétés dans cette réponse.

Options
Options string

Définissez une ou plusieurs des options généralement définies dans Options utilisateur pour cette recherche uniquement. Utilisez des ID à partir de /PropertyDef ? Get=SearchOptions service, ajoutez un signe moins à définir sur false, sinon true est supposé.

Taille de page
pageSize integer

Nombre d’éléments à retourner dans chaque page de résultats. Si elle est vide, la valeur par défaut est définie par défaut dans la configuration.

Valeur de propriété
PropertyValue string

Incluez la valeur brute, la valeur de chaîne ou les deux dans les résultats.

Collection de propriétés
PropertySets string

Un ou plusieurs ensembles de propriétés prédéfinis, sélectionnez à partir de DataGridVisible, Detailed, FromSearch, All ou un jeu de propriétés personnalisé tel que défini dans votre configuration de service.

Objectif
purpose integer

Propriété spéciale pour filtrer les résultats de recherche en fonction des valeurs d’énumération d’objet Usage.

Objectif supplémentaire
purposeExtra integer

Nécessaire en tant que supplément à certaines fins. Le service ObjectDef fournit des informations sur l’énumération ou le type TrimMainObject à spécifier, en particulier ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes et HaveExtraPurposeParameter.

Trier par
sortBy string

Liste séparée par des virgules des ID de clause de recherche. Utilisez : pour spécifier la décroissante. Par exemple, Number- pour trier les enregistrements par nombre décroissant.

Démarrer
start integer

Position du jeu de résultats pour démarrer, vide (ou 1) pour commencer au début, 2 pour commencer au deuxième objet, 3 au troisième, etc.

StringDisplayType
StringDisplayType string

Si vous retournez la valeur de chaîne au format à utiliser.

Propriétés
properties string

Liste séparée par des virgules des propriétés d’objet, par exemple Uri,NameString

Retours

Rechercher l’emplacement par ID

Récupérer un emplacement unique par ID unique ou nom

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Id True string

ID unique ou nom de l’objet

Propriétés descendantes
descendantProperties string

Une liste séparée par des virgules des propriétés d’objet s’applique uniquement aux propriétés d’objet de ce niveau inférieur et de cette propriété de niveau inférieur, par exemple Name,GivenNames

Inclure des définitions de propriétés
IncludePropertyDefs boolean

True pour retourner un tableau des définitions de propriétés utilisées par les propriétés dans cette réponse

Propriétés
properties string

Liste séparée par des virgules des propriétés d’objet, par exemple Nom_famille,GivenNames

Collection de propriétés
propertySets string

Un ou plusieurs ensembles de propriétés prédéfinis, sélectionnez à partir de DataGridVisible, Détaillé, FromSearch, All ou un jeu de propriétés personnalisé tel que défini dans votre configuration de service

Valeur de propriété
PropertyValue string

Inclure la valeur brute, la valeur de chaîne ou les deux dans les résultats

Type d’affichage de chaîne
stringDisplayType string

Retourne la valeur de chaîne au format à utiliser

Retours

Rechercher un enregistrement par ID

Récupérer un enregistrement unique par ID unique ou nom

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

ID
Id True string

ID unique ou nom de l’objet

Inclure des définitions de propriétés
IncludePropertyDefs boolean

True pour retourner un tableau des définitions de propriétés utilisées par les propriétés dans cette réponse

Propriétés descendantes
descendantProperties string

Une liste séparée par des virgules des propriétés d’objet s’applique uniquement aux propriétés d’objet de cette propriété de niveau inférieur, par exemple RecordNumber,RecordTitle.

Propriétés
properties string

Liste séparée par des virgules des propriétés d’objet, par exemple RecordNumber,RecordTitle.

Collection de propriétés
propertySets string

Un ou plusieurs ensembles de propriétés prédéfinis, sélectionnez à partir de DataGridVisible, Detailed, FromSearch, All ou un jeu de propriétés personnalisé tel que défini dans votre configuration de service.

Valeur de propriété
PropertyValue string

Inclure la valeur brute, la valeur de chaîne ou les deux dans les résultats

Type d’affichage de chaîne
stringDisplayType string

Si vous retournez la valeur de chaîne au format à utiliser

Retours

Rechercher un ID unique de l’adresse d’emplacement

Obtenir l’ID unique de l’adresse enfant d’un emplacement

Paramètres

Nom Clé Obligatoire Type Description
Type
type string

Sélectionner le type d’adresse

Identificateur unique
LocationUri True string

ID unique de l’emplacement

Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Retours

Adresse enfant
CMLocationAddressUri

Supprimer un enregistrement

Supprimer un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Identificateur unique
Uri True integer

ID unique de l’enregistrement à supprimer

Supprimer le contenu ?
DeleteContents True boolean
Nouvelle page d’accueil pour le contenu
NewHomeForContents string

ID unique ou adresse e-mail du nouvel emplacement d’accueil pour le contenu

Retours

Télécharger un fichier électronique

Télécharger un fichier électronique d’un enregistrement

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique
uri True string

ID unique ou numéro d’enregistrement

Utilisateur à emprunter l’identité
userToImpersonate string

Connexion réseau ou autre connexion de l’emplacement dans CM pour emprunter l’identité

Retours

response
binary

Définitions

CMRecord

Nom Chemin d’accès Type Description
Chemin d’accès au fichier
RecordFilePath string

Nom de fichier tel qu’il apparaît dans le dossier Uploads

Numéro d’adhésion
RecordAccessionNumber integer
Destinataire
RecordAddressee integer
Autre conteneur
RecordAlternativeContainer integer
Assignee
RecordAssignee integer
Auteur
RecordAuthor integer
Méthode d’autorisation
RecordAuthorizationMethod string
Niveau de confiance de classification automatique
RecordAutoClassificationConfidenceLevel integer
Rendu automatique au format PDF lors de l’enregistrement
RecordAutoRenderToPDFOnSave boolean
Titre d’impression bleue
RecordBlueprintTitle string
Ignorer les contrôles d’accès au type d’enregistrement
RecordBypassRecordTypeAccessControls boolean
Archivé par
RecordCheckedInBy integer
Extrait à
RecordCheckedOutTo integer
Classification
RecordClassification integer
Classe d’enregistrement
RecordClassOfRecord string
Client
RecordClient integer
Enregistrement client
RecordClientRecord integer
Consignation
RecordConsignment string
Objet d’envoi
RecordConsignmentObject string
Conteneur
RecordContainer integer
Créateur
RecordCreator integer
Version actuelle
RecordCurrentVersion string
Date fermée
RecordDateClosed date-time
Date de création
RecordDateCreated date-time
Date d’échéance
RecordDateDue date-time
Date finalisée
RecordDateFinalized date-time
Date importée
RecordDateImported date-time
Date Inactive
RecordDateInactive date-time
Date de modification
RecordDateModified date-time
Date de publication
RecordDatePublished date-time
Date reçue
RecordDateReceived date-time
Date inscrite
RecordDateRegistered date-time
Attachement de document en attente
RecordDocumentAttachPending boolean
Taille du document
RecordDocumentSize integer
Type du document
RecordDocumentType string
Editor
RecordEditor integer
Magasin de documents électroniques
RecordEStore integer
Document Extension
RecordExtension string
Référence externe
RecordExternalReference string
Finaliser l’enregistrement
RecordFinalizeOnSave boolean
Origine du dossier
RecordFolderOrigin integer
Code-barres étranger
RecordForeignBarcode string
Titre généré
RecordGeneratedTitle string
Emplacement GPS
RecordGpsLocation string
Emplacement de la maison
RecordHomeLocation integer
Espace d’accueil
RecordHomeSpace integer
Lancer un modèle
RecordInitiateTemplate string

ID unique du modèle de flux de travail

Est placé entre deux
RecordIsEnclosed boolean
Compétence
RecordJurisdictions string
Date de la dernière action
RecordLastActionDate date-time
Dernier enregistrement de partie
RecordLastPartRecord integer
Version la plus récente
RecordLatestVersion integer
Nombre développé
RecordLongNumber string
Numéro d’enregistrement
RecordNumber string
Date de destruction manuelle
RecordManualDestructionDate date-time
Enregistrement de la matière
RecordMatterRecord integer
Type de support
RecordMediaType string
Réunion
RecordMeeting integer
Mime Type
RecordMimeType string
Mes commentaires d’autorisation
RecordMyAuthorizationComments string
Mon autorisation est terminée
RecordMyAuthorizationComplete boolean
Mes commentaires de révision
RecordMyReviewComments string
Mon avis est terminé
RecordMyReviewComplete boolean
Nombre de pages ?
RecordNbrPages integer
Vous devez disposer d’une autorisation ?
RecordNeedsAuthorization boolean
Besoin d’un examen ?
RecordNeedsReview boolean
Nouvelle règle de création de composant
RecordNewPartCreationRule string

ID unique de la règle de création de composants automatiques

Enregistrement de partie suivante
RecordNextPartRecord integer
Type de mise à jour des notes
NotesUpdateType string
Remarques
RecordNotes string
Provient de
RecordOriginatedFrom string
Origine de l’exécution
RecordOriginatedFromRun string
Autre contact
RecordOtherContact integer
Emplacement du propriétaire
RecordOwnerLocation integer
Hiérarchie de la conservation sur l’entrée de données ?
RecordPreserveHierarchyOnDataEntry boolean
Enregistrement de partie précédente
RecordPrevPartRecord integer
Contact principal
RecordPrimaryContact integer
Priority
RecordPriority string
Type d’enregistrement
RecordRecordType integer
Enregistrement associé
RecordRelatedRecord integer
Représentant
RecordRepresentative integer
Planification de rétention
RecordRetentionSchedule integer
Date de révision
RecordReviewDate date-time
Vérifier la date d’échéance
RecordReviewDueDate date-time
État de révision
RecordReviewState string
Enregistrement de composant racine
RecordRootPartRecord integer
Security
RecordSecurity string
Enregistrement de série
RecordSeriesRecord integer
Titre
RecordTitle string
Titre (partie texte libre)
RecordTypedTitle string
Identificateur unique
Uri integer
Champs supplémentaires
Fields object

CMEventData

Nom Chemin d’accès Type Description
Identificateur unique d’événement
OnlineEventUri integer
ID de type d’événement
EventType integer
Type d'événement
EventTypeString string
Date de l’événement
EventDate date-time
ID de type d’objet
ObjectType integer
Type d'objet
ObjectTypeString string
ID unique de l’objet
ObjectUri integer
ID de type d’objet associé
RelatedObjectType integer
Type d’objet connexe
RelatedObjectTypeString string
ID unique de l’objet associé
RelatedObjectUri integer
À partir de l’ordinateur
FromMachine string
Adresse IP de connexion
ConnectionIPAddress string
Adresse IP du client
ClientIPAddress string
À partir du fuseau horaire
FromTimeZone integer
Nom de connexion
LoginName string
ID unique de connexion
LoginUri integer
Détails supplémentaires
ExtraDetails string

CMLogMessage

Nom Chemin d’accès Type Description
Message de journal
LogMessage string
Rechercher
TrimType CMTrimType
Identificateur unique
Uri integer

CMRecordsResponse

Nom Chemin d’accès Type Description
Results
Results array of CMRecord
UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Résultats totaux
TotalResults integer
Count String Ex
CountStringEx string
Nombre minimal
MinimumCount integer
Nombre
Count integer
Contient plus d’éléments
HasMoreItems boolean
Titre de la recherche
SearchTitle string
Chaîne de mise en surbrillance de l’accès
HitHighlightString string
Rechercher
TrimType CMTrimType
État de la réponse
ResponseStatus CMResponseStatus

État de la réponse

CMLogResponse

Nom Chemin d’accès Type Description
Results
Results array of CMLogMessage
UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Résultats totaux
TotalResults integer
Count String Ex
CountStringEx string
Nombre minimal
MinimumCount integer
Nombre
Count integer
Contient plus d’éléments
HasMoreItems boolean
Titre de la recherche
SearchTitle string
Chaîne de mise en surbrillance de l’accès
HitHighlightString string
Rechercher
TrimType CMTrimType
État de la réponse
ResponseStatus CMResponseStatus

État de la réponse

CMUpdateErrorResponse

Réponse d’erreur de mise à jour

Nom Chemin d’accès Type Description
Code d’erreur
ErrorCode string
Identificateur unique
Uri integer
Message
Message string
Nom
Name string
Nom (supplémentaire)
NameExtra string

CMResponseStatus

État de la réponse

Nom Chemin d’accès Type Description
Code d’erreur
ErrorCode string
Message
Message string
StackTrace
StackTrace string
Errors
Errors array of CMResponseError
Meta
Meta object

Chaîne de<dictionnaire, chaîne>

CMResponseError

Erreur de réponse

Nom Chemin d’accès Type Description
Code d’erreur
ErrorCode string
Nom du champ
FieldName string
Message
Message string
Meta
Meta object

Chaîne de<dictionnaire, chaîne>

CMTrimType

Rechercher
string

CMLocation

Nom Chemin d’accès Type Description
Identificateur unique
Uri integer
Nom
NameString string
Nom complet mis en forme à l’emplacement
LocationFullFormattedName string
Nom de tri de l’emplacement
LocationSortName string

CMBob

Nom Chemin d’accès Type Description
Identificateur unique
Uri integer
Nom
NameString string

CMLocationsResponse

Nom Chemin d’accès Type Description
Results
Results array of CMLocation

Results

UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Résultats totaux
TotalResults integer
Count String Ex
CountStringEx string
Nombre minimal
MinimumCount integer
Nombre
Count integer
Contient plus d’éléments
HasMoreItems boolean
Titre de la recherche
SearchTitle string
Chaîne de mise en surbrillance de l’accès
HitHighlightString string
Rechercher
TrimType CMTrimType
État de la réponse
ResponseStatus CMResponseStatus

État de la réponse

CMBobResponse

Nom Chemin d’accès Type Description
Results
Results array of CMBob

Results

UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Résultats totaux
TotalResults integer
Count String Ex
CountStringEx string
Nombre minimal
MinimumCount integer
Nombre
Count integer
Contient plus d’éléments
HasMoreItems boolean
Titre de la recherche
SearchTitle string
Chaîne de mise en surbrillance de l’accès
HitHighlightString string
Rechercher
TrimType CMTrimType
État de la réponse
ResponseStatus CMResponseStatus

État de la réponse

GetFileFromUrlResponse

Réponse du plug-in API du service CM « GetFileFromUrl ».

Nom Chemin d’accès Type Description
Chemin de fichier
Filepath string

Chemin d’accès au fichier local téléchargé à partir de l’URL.

Message
Message string

CMLocationAddressUri

Nom Chemin d’accès Type Description
ID unique
Uri integer

binaire

Il s’agit du type de données de base "binaire".

objet

Il s’agit du type 'object'.