Rubrique précédente: createDocumentRubrique suivante: deleteDocument


modifyDocument

Les paramètres suivants s’appliquent à la méthode modifyDocument :

Paramètre

Type

Description

SID

Nombre entier

Identifie la session extraite depuis la connexion.

docId

Nombre entier

Identifie l’ID unique du document que vous souhaitez modifier.

kdAttributes

Chaîne[]

Indique les paires nom-valeur pour la mise à jour, par exemple, "SUMMARY", "Summary text", "TITLE" et "Title text".

Dans le cadre de la méthode modifyDocument, le tableau ci-dessous contient des exemples de valeurs d’attributs valides et couramment utilisées pour un document. Les données de la colonne Type indiquent la nature exacte des informations qui doivent être analysées par la méthode au format chaîne dans le tableau de la chaîne attrVals.

Paramètre

Type

Description

MODIFY_DATE

(Chaîne)

Indique un champ spécial utilisé pour verrouiller les enregistrements afin que les autres utilisateurs ne puissent pas mettre à jour le document en même temps que vous. Vous devez transmettre le paramètre MODIFY_DATE existant du document. Si aucune valeur n'est indiquée, un message d'erreur vous indique qu'un autre utilisateur a mis à jour le document.

USER_DEF_ID

Chaîne

Identifie tous les ID que vous souhaitez utiliser pour représenter le document.

TITLE

Chaîne

Indique le titre du document.

SUMMARY

Chaîne

Indique le résumé du document.

PROBLEM

Chaîne

Indique le problème du document.

RESOLUTION

Chaîne

Indique la résolution du document. Cette chaîne peut contenir des données au format html.

STATUS_ID

Nombre entier

Indique l’ID d’état du document. La valeur par défaut est 10 (Version).

PRIORTY_ID

Nombre entier

Indique l’ID de priorité du document. La valeur par défaut est (Normal).

START_DATE

Date (Chaîne)

Indique la date à laquelle le document devient actif et doit être également utilisé avec le paramètre ExpirationDate. Ne pas renseigner si vous ne souhaitez pas spécifier de date de début. Le document reste actif tant qu’il n’a pas atteint la date d’expiration.

EXPIRATION_DATE

Date (Chaîne)

Indique la date à laquelle le document expire et doit être utilisé avec le paramètre StartDate. Ne pas renseigner si vous ne souhaitez pas spécifier de date d’expiration.

SD_PRODUCT_ID

Nombre entier

Indique l'ID de produit de CA SDM auquel associer ce document.

ASSIGNEE_ID

UUID

Indique l'ID unique de CA SDM auquel ce document est affecté.

SD_ASSET_ID

UUID

Indique l'ID d'actif de CA SDM auquel associer ce document.

SD_ROOTCAUSE_ID

Nombre entier

Indique l'ID de la cause première de CA SDM à laquelle associer ce document.

SD_PRIORITY_ID

Nombre entier

Indique l'ID de la priorité de CA SDM à laquelle associer ce document.

SD_SEVERITY_ID

Nombre entier

Indique l'ID de la sévérité de CA SDM à laquelle associer ce document.

SD_IMPACT_ID

Nombre entier

Indique l'ID de l'impact de CA SDM à laquelle associer ce document.

SD_URGENCY_ID

Nombre entier

Spécifie l'ID d'urgence de CA SDM à laquelle associer ce document.

AUTHOR_ID

UUID

Identifie l’ID unique du contact qui a créé ce document. Si l’auteur n’est pas un contact interne, vous pouvez définir ce champ sur zéro (0) et utiliser le paramètre Auteur.

OWNER_ID

UUID

Identifie l’ID unique du contact propriétaire du document.

SUBJECT_EXPERT_ID

UUID

Indique l’ID unique du contact expert du sujet du document.

NOTES

Chaîne

Indique les remarques du document.

READ_GROUP_LIST

Chaîne

Indique la liste de données séparées par des tirets des ID de groupe dotés de l'autorisation de lecture pour ce document (par exemple : 1-3-4). Utilisez la lettre A pour affecter une autorisation à tout le monde.

WRITE_GROUP_LIST

Chaîne

Indique la liste de données séparées par des tirets des ID de groupe dotés de l'autorisation d'écriture pour ce document (par exemple : 1-3-4). Utilisez la lettre A pour affecter une autorisation à tout le monde.

INHERIT_PERMISSION

Booléen

Indique l’état de l’indicateur Hériter des autorisations. Définir sur Vrai pour hériter des autorisations de la catégorie dans laquelle le document est créé. S’il est défini sur Vrai, les paramètres ReadPermissions et WritePermissions sont ignorés.

DOC_TYPE_ID

Nombre entier

Identifie l’ID du futur type de document, à savoir document standard ou document d’arborescence. Par défaut, il s’agit d’un document standard.

HITS

Nombre entier

Indique le nombre de fois que le document a été affiché.

DOC_TEMPLATE_ID

Nombre entier

Identifie l’ID du modèle que vous souhaitez affecter à ce document.

WF_TEMPLATE

Nombre entier

Identifie l’ID du modèle de flux de travaux que vous souhaitez affecter à ce document.

WF_ACTION

Chaîne

Identifie l'action du flux de travaux que vous souhaitez affecter à ce document. Par exemple, wf_unpublish laisse le document devenir non publié.

WF_COMMENT

Chaîne

Identifie le commentaire du flux de travaux que vous souhaitez affecter à ce document. Par exemple, non publier.

WF_CONTACT_ID

UUID

Identifie l'ID utilisateur de flux de travaux que vous souhaitez affecter à ce document.

WF_REJECT_TO_ID

Nombre entier

Identifie l'ID de tâche pour le flux de travaux que vous voulez affecter à ce document, en correspondant son processus d'approbation. Les ID de tâche sont stockés dans la table CI_ACTIONS.

CUSTOM1

Chaîne

Définit un champ personnalisé.

CUSTOM2

Chaîne

Définit un champ personnalisé.

CUSTOM3

Chaîne

Définit un champ personnalisé.

CUSTOM4

Chaîne

Définit un champ personnalisé.

CUSTOM5

Chaîne

Définit un champ personnalisé.

CUSTOMNUM1

Double

Définit un champ numérique personnalisé.

CUSTOMNUM2

Double

Définit un champ numérique personnalisé.

Description

Modifie un document.

Eléments renvoyés

Un nœud <UDSObject> décrivant le document de connaissances modifié.