Class TemplateInstancesApi

Create Template Instances

const instances = [
  { externalId: 'Well_a', templateName: "Well", fieldResolvers: { name: "Underwater P23", pressure: "21_PT19" } },
  { externalId: 'Well_b', templateName: "Well", fieldResolvers: { name: "Underwater P01" } },
];
const createdInstances = await client.templates.group("myGroup").version(1).create(instances);
Copy

Deprecated

Templates API was retired 2025-05-31 and will be removed in the next major release.

Delete Template Instances

const instances = await client.templates.group("myGroup").version(1).delete([{ externalId: ["Well_a"] }]);
Copy

Deprecated

Templates API was retired 2025-05-31 and will be removed in the next major release.

List Template Instances

const instances = await client.templates.group("myGroup").version(1).list( { templateNames: ["Well"] } );
Copy

Deprecated

Templates API was retired 2025-05-31 and will be removed in the next major release.

Retrieve Template Instances

const instances = await client.templates.group("myGroup").version(1).retrieve([ { externalId: 'Well } ]);
Copy

Deprecated

Templates API was retired 2025-05-31 and will be removed in the next major release.

Update Template Instances

const instances = await client.templates.group("myGroup").version(1).update( [{ update: {
  fieldResolvers: {
    set: {
      myStringField: "My Field"
    }
  }
}, externalId: 'someExtId' }] );
Copy

Deprecated

Templates API was retired 2025-05-31 and will be removed in the next major release.

Upsert Template Instances

const instances = [
  { externalId: "Well_a", templateName: "Well", fieldResolvers: { name: "Underwater P23", pressure: "21_PT19" } },
  { externalId: "Well_b", templateName: "Well", fieldResolvers: { name: "Underwater P01" } },
];
const createdInstances = await client.templates.group("myGroup").version(1).upsert(instances);
Copy

Deprecated

Templates API was retired 2025-05-31 and will be removed in the next major release.