Working with Integrator Objects and APIs

General

This article explains how to work with Integrator objects and services in scripts. It focuses on practical usage rather than full reference documentation.

Overview

Scripts interact with backend objects such as:

• transaction
• article
• structureArticle
• service classes

For full definitions, see:

• /hc/en-us/articles/20666520260252-object-class-definitions-in-javascript-editor
• /hc/en-us/articles/20668104823452-integrator-api-functions-in-javascript-editor

Working with Articles

Reading Values

var itemNumber = article.ItemNum;
var description = article.GetVaultProperty("Description");

Updating Values

article.AddUpdateVaultProperty("Revision", "A");

Working with Transactions

for (var i = 0; i < transaction.Articles.Count; i++) {
    var article = transaction.Articles[i];
}

Common use cases:

• validation across articles
• building output values
• logging

Using Services

Logging

LogService.SaveTransactionLog(0, transaction.Id, "Title", "Message", "Integrator Script Action");

Data Persistence

ArticleService.UpdateArticleProperties(article.Id, article.ArticleProperties);

External API Calls

var client = ClientService.GetClient("ClientName");
var result = client.Call(request);

Using Enums

Enums represent predefined system values.

Example:

if (article.ModuleStatus == 0) {
    return "New";
}

For full enum definitions:

• /hc/en-us/articles/20668016782108-enums