SystemDocumentVersion : champ d’application, global

L’API SystemDocumentVersion fournit des méthodes permettant de définir les valeurs de la version source d’un document dans la table Versions [ds_document_version].

Cette API requiert le module d’extension Document Management (com.snc.platform_document_management) et est fournie dans l’espace de noms sn_doc_services . Pour plus d’informations, consultez Services documentaires.

Pour créer une version de document, utilisez l’API DocumentVersionService.

SystemDocumentVersion : SystemDocumentVersion(String docSysId)

Instancie un objet SystemDocumentVersion .

Tableau 1. Paramètres

Nom	Type	Description
ID docSysId	Chaîne	Sys_id d’un enregistrement de document dans la table Documents [ds_document].

Tableau 2. Renvoie

Type	Description
Néant

L’exemple suivant montre comment instancier un objet SystemDocumentVersion et créer une version de document. Voir aussi DocumentVersionService.

var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

Sortie :

{
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

SystemDocumentVersion : document(String docSysId)

Spécifie l’enregistrement de document pour cette version.

Remarque :

Vous pouvez également définir le nom en tant que paramètre dans le constructeur SystemDocumentVersion().

Tableau 3. Paramètres

Nom	Type	Description
ID docSysId	Chaîne	Sys_id d’un enregistrement de document dans la table Documents [ds_document].

Tableau 4. Renvoie

Type	Description
Néant

L’exemple suivant montre comment définir le champ nom d’une version de document. Voir aussi DocumentVersionService – createDocumentVersion().

var versionDefinition = new sn_doc_services.SystemDocumentVersion();

versionDefinition.document('491efbee24187410f877a6fed1c2b0a9');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

Sortie :

{
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : 1c504c91242cf810f877a6fed1c2b08b is successful.",
  "request_id": "1c504c91242cf810f877a6fed1c2b08b",
  "status": "success"
}

SystemDocumentVersion – type(String docType)

Définit le champ Type d’une version de document.

Tableau 5. Paramètres

Nom	Type	Description
docType	Chaîne	Type de source de document. Valeurs valides : URL attachment Valeur par défaut : pièce jointe Remarque : Une pièce jointe ne peut actuellement être ajoutée que dans l’interface utilisateur de la table Versions de document [ds_document_version] et non avec l’API.

Tableau 6. Renvoie

Type	Description
Néant

L’exemple suivant montre comment définir le champ de type et créer une version de document. Voir aussi DocumentVersionService.

var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

{
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

SystemDocumentVersion : url(String url)

Définit l’URL d’une version de document.

Tableau 7. Paramètres

Nom	Type	Description
URL	Chaîne	URL du document source pour cette version.

Tableau 8. Renvoie

Type	Description
Néant

L’exemple suivant montre comment définir le champ URL comme source d’une version de document. Voir aussi DocumentVersionService.

var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

{
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

SystemDocumentVersion : versionNumber(Number versionNumber)

Définit le numéro d’une version de document.

Tableau 9. Paramètres

Nom	Type	Description
versionNumber	Numéro	Numéro de version de ce document.

Tableau 10. Renvoie

Type	Description
Néant

L’exemple suivant montre comment définir le numéro de version et créer une version de document. Voir aussi DocumentVersionService.

var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');
versionDefinition.versionNumber(5);

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

Sortie :

{
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : ff47449d242cf810f877a6fed1c2b06c is successful.",
  "request_id": "ff47449d242cf810f877a6fed1c2b06c",
  "status": "success"
}