Materiel

Palantir Defense Ontology

[Palantir Defense Ontology] Represents a specific instance of equipment, supply, or other materiel used in military operations.

Properties

Materiel Id
string

[Palantir Defense Ontology] A string property type which captures materiel ID.

Materiel Id Type
string

[Palantir Defense Ontology] A string property type which captures the materiel ID type (e.g., NSN).

Materiel Name
string

[Palantir Defense Ontology] A string property type which captures the name of a materiel.

Materiel Taxonomy Ids
list<item>

[Palantir Defense Ontology] An array of strings used to capture materiel taxonomy IDs.

One To Many
optional

[Palantir Defense Ontology] Links a materiel item to its taxonomy classification.

One To Many
optional

[Palantir Defense Ontology] Links a materiel item to its many requirements across units.

One To Many
optional

[Palantir Defense Ontology] Links a materiel item to its many change events.

One To Many
optional

[Palantir Defense Ontology] Links a materiel item to its many status events.

Code snippets

TypeScript

Load Materiel metadata

Copied!
1 2 3 4 5 6 7 8 import { com.palantir.defense.ontology.Materiel } from "@osdk/defense-ontology"; // Edit this import if your client location differs import { client } from "./client"; const interfaceTypeMetadata = await client.fetchMetadata(com.palantir.defense.ontology.Materiel); const implementingObjectTypes = interfaceTypeMetadata.implementedBy; const interfaceRid = interfaceTypeMetadata.rid;

Filtering

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 import { com.palantir.defense.ontology.Materiel } from "@osdk/defense-ontology"; // Edit this import if your client location differs import { client } from "./client"; import { isOk, type Osdk, type PageResult, type Result } from "@osdk/client"; const page: Result<PageResult<Osdk<com.palantir.defense.ontology.Materiel>>> = await client(com.palantir.defense.ontology.Materiel) .where({ $and:[ { $not: { someProperty: { $isNull: true }}}, { someProperty: { $eq: "foo" }} ] }) .fetchPageWithErrors({ $pageSize: 30 }); if (isOk(page)) { const interfaces = page.value.data; const interface1 = interfaces[0]; }

Load ordered Materiel

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 import { com.palantir.defense.ontology.Materiel } from "@osdk/defense-ontology"; // Edit this import if your client location differs import { client } from "./client"; import { isOk, type Osdk, type PageResult, type Result } from "@osdk/client"; const page: Result<PageResult<Osdk<com.palantir.defense.ontology.Materiel>>> = await client(com.palantir.defense.ontology.Materiel) .fetchPageWithErrors({ $orderBy: {"someProperty": "asc"}, $pageSize: 30 }); if (isOk(page)) { const interfaces = page.value.data; const interface1 = interfaces[0]; }

Subscribe to object sets

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 import { com.palantir.defense.ontology.Materiel } from "@osdk/defense-ontology"; // Edit this import if your client location differs import { client } from "./client"; // A map of primary keys to objects loaded through the SDK const objects: { [key: string]: com.palantir.defense.ontology.Materiel.OsdkInstance } = ... const subscription = client(com.palantir.defense.ontology.Materiel).subscribe( { onChange(update) { if (update.state === "ADDED_OR_UPDATED") { // An object has received an update or an object was added to the object set const currentObject = objects[update.object.$primaryKey]; if (currentObject !== undefined) { currentObject["<propertyName>"] = update.object["<propertyName>"] ?? currentObject["<propertyName>"]; } } else if (update.state === "REMOVED") { // The object was removed from the object set, which could mean it was deleted or no longer meets the filter criteria delete objects[update.object.$primaryKey]; } }, onSuccessfulSubscription() { // The subscription was successful and you can expect to receive updates }, onError(err) { // There was an error with the subscription and you will not receive any more updates console.error(err); }, onOutOfDate() { // We could not keep track of all changes. Please reload the objects in your set. }, }, { properties: [ "com.palantir.defense.ontology.materielId", "com.palantir.defense.ontology.materielIdType", "com.palantir.defense.ontology.materielName", "com.palantir.defense.ontology.materielTaxonomyIds", ]} ); subscription.unsubscribe();

Load all Materiel

Copied!
1 2 3 4 5 6 7 8 9 10 11 import { com.palantir.defense.ontology.Materiel } from "@osdk/defense-ontology"; // Edit this import if your client location differs import { client } from "./client"; import type { Osdk } from "@osdk/client"; const interfaces: Osdk<com.palantir.defense.ontology.Materiel>[] = []; for await(const int of client(com.palantir.defense.ontology.Materiel).asyncIter()) { interfaces.push(int); } const interface1 = interfaces[0];

Load pages of Materiel

Copied!
1 2 3 4 5 6 7 8 9 10 11 import { com.palantir.defense.ontology.Materiel } from "@osdk/defense-ontology"; // Edit this import if your client location differs import { client } from "./client"; import { type Osdk, type PageResult, type Result } from "@osdk/client"; const response: Result<PageResult<Osdk<com.palantir.defense.ontology.Materiel>>> = await client(com.palantir.defense.ontology.Materiel).fetchPageWithErrors({ $pageSize: 30 }); // To fetch a page without a result wrapper, use fetchPage instead const responseNoErrorWrapper: PageResult<Osdk<com.palantir.defense.ontology.Materiel>> = await client(com.palantir.defense.ontology.Materiel).fetchPage({ $pageSize: 30 });