@osdk/foundry.ontologies 2.43.0 → 2.45.0

package/build/esm/_components.d.ts

@@ -24,6 +24,12 @@ export interface AbsoluteValuePropertyExpression {
  * Log Safety: UNSAFE
  */
 export type Action = LooselyBrandedString<"Action">;
+/**
+ * An ISO 8601 timestamp.
+ *
+ * Log Safety: SAFE
+ */
+export type ActionExecutionTime = string;
 /**
  * A detailed operation for an Action
  *
@@ -529,6 +535,16 @@ export type AggregationV2 = ({
 } & SumAggregationV2) | ({
     type: "exactDistinct";
 } & ExactDistinctAggregationV2);
+/**
+ * Matches intervals satisfying all the rules in the query
+ *
+ * Log Safety: UNSAFE
+ */
+export interface AllOfRule {
+    rules: Array<IntervalQueryRule>;
+    maxGaps?: number;
+    ordered: boolean;
+}
 /**
    * Returns objects where the specified field contains all of the whitespace separated words in any
 order in the provided value. This query supports fuzzy matching.
@@ -556,6 +572,14 @@ export interface AndQuery {
 export interface AndQueryV2 {
     value: Array<SearchJsonQueryV2>;
 }
+/**
+ * Matches intervals satisfying any of the rules in the query
+ *
+ * Log Safety: UNSAFE
+ */
+export interface AnyOfRule {
+    rules: Array<IntervalQueryRule>;
+}
 /**
    * Returns objects where the specified field contains any of the whitespace separated words in any
 order in the provided value. This query supports fuzzy matching.
@@ -571,6 +595,13 @@ export interface AnyTermQuery {
  * Log Safety: SAFE
  */
 export type ApplyActionMode = "VALIDATE_ONLY" | "VALIDATE_AND_EXECUTE";
+/**
+ * Log Safety: SAFE
+ */
+export interface ApplyActionOverrides {
+    uniqueIdentifierLinkIdValues: Record<UniqueIdentifierLinkId, UniqueIdentifierValue>;
+    actionExecutionTime?: ActionExecutionTime;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -596,6 +627,13 @@ export interface ApplyActionRequestV2 {
  */
 export interface ApplyActionResponse {
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ApplyActionWithOverridesRequest {
+    request: ApplyActionRequestV2;
+    overrides: ApplyActionOverrides;
+}
 /**
  * Performs both apply reducers and extract main value to return the reduced main value.
  *
@@ -907,6 +945,36 @@ export type CenterPointTypes = {
  * Log Safety: UNSAFE
  */
 export type CipherTextProperty = LooselyBrandedString<"CipherTextProperty">;
+/**
+   * The conjunctive set of markings required to access the property value.
+All markings from a conjunctive set must be met for access.
+   *
+   * Log Safety: UNSAFE
+   */
+export type ConjunctiveMarkingSummary = Array<MarkingId>;
+/**
+   * The conjunctive set of markings for the container of this property value,
+such as the project of a dataset. These markings may differ from the marking
+on the actual property value, but still must be satisfied for accessing the property
+All markings from a conjunctive set must be met for access.
+   *
+   * Log Safety: UNSAFE
+   */
+export type ContainerConjunctiveMarkingSummary = Array<MarkingId>;
+/**
+   * The disjunctive set of markings for the container of this property value,
+such as the project of a dataset. These markings may differ from the marking
+on the actual property value, but still must be satisfied for accessing the property
+
+All markings from a conjunctive set must be met for access.
+Disjunctive markings are represented as a conjunctive list of disjunctive sets.
+The top-level set is a conjunction of sets, where each inner set should be
+treated as a unit where any marking within the set can satisfy the set.
+All sets within the top level set should be satisfied.
+   *
+   * Log Safety: UNSAFE
+   */
+export type ContainerDisjunctiveMarkingSummary = Array<Array<MarkingId>>;
 /**
    * Returns objects where the specified field contains all of the terms in the order provided,
 but they do have to be adjacent to each other.
@@ -1326,6 +1394,16 @@ export interface DerivedTimeSeriesProperty {
     templateRid: TimeseriesTemplateRid;
     templateVersion?: TimeseriesTemplateVersion;
 }
+/**
+   * The disjunctive set of markings required to access the property value.
+Disjunctive markings are represented as a conjunctive list of disjunctive sets.
+The top-level set is a conjunction of sets, where each inner set should be
+treated as a unit where any marking within the set can satisfy the set.
+All sets within the top level set should be satisfied.
+   *
+   * Log Safety: UNSAFE
+   */
+export type DisjunctiveMarkingSummary = Array<Array<MarkingId>>;
 /**
  * Divides the left numeric value by the right numeric value.
  *
@@ -1434,6 +1512,13 @@ export interface Error {
     error: ErrorName;
     args: Array<Arg>;
 }
+/**
+ * Indicates the server was not able to load the securities of the property.
+ *
+ * Log Safety: SAFE
+ */
+export interface ErrorComputingSecurity {
+}
 /**
  * Log Safety: SAFE
  */
@@ -1666,8 +1751,8 @@ export type Icon = {
 } & BlueprintIcon;
 /**
    * Returns objects where the specified field equals any of the provided values. Allows you to
-specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied,
-but not both.
+specify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects
+in the object set. Either field or propertyIdentifier must be supplied, but not both.
    *
    * Log Safety: UNSAFE
    */
@@ -1761,6 +1846,14 @@ export type InterfacePropertyApiName = LooselyBrandedString<"InterfacePropertyAp
 export interface InterfacePropertyLocalPropertyImplementation {
     propertyApiName: PropertyApiName;
 }
+/**
+ * An implementation of an interface property via applying reducers on the nested implementation.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface InterfacePropertyReducedPropertyImplementation {
+    implementation: NestedInterfacePropertyTypeImplementation;
+}
 /**
  * An implementation of an interface property via the field of a local struct property.
  *
@@ -1775,7 +1868,16 @@ struct fields to local struct fields or properties.
    *
    * Log Safety: UNSAFE
    */
-export type InterfacePropertyStructImplementation = Record<StructFieldApiName, PropertyOrStructFieldOfPropertyImplementation>;
+export interface InterfacePropertyStructImplementation {
+    mapping: InterfacePropertyStructImplementationMapping;
+}
+/**
+   * An implementation of a struct interface property via a local struct property. Specifies a mapping of interface
+struct fields to local struct fields or properties.
+   *
+   * Log Safety: UNSAFE
+   */
+export type InterfacePropertyStructImplementationMapping = Record<StructFieldApiName, PropertyOrStructFieldOfPropertyImplementation>;
 /**
    * The definition of an interface property type on an interface. An interface property can either be backed by a
 shared property type or defined on the interface directly.
@@ -1798,7 +1900,9 @@ export type InterfacePropertyTypeImplementation = ({
     type: "structImplementation";
 } & InterfacePropertyStructImplementation) | ({
     type: "localPropertyImplementation";
-} & InterfacePropertyLocalPropertyImplementation);
+} & InterfacePropertyLocalPropertyImplementation) | ({
+    type: "reducedPropertyImplementation";
+} & InterfacePropertyReducedPropertyImplementation);
 /**
  * The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.
  *
@@ -1900,6 +2004,31 @@ export interface IntersectsPolygonQuery {
     propertyIdentifier?: PropertyIdentifier;
     value: PolygonValue;
 }
+/**
+   * Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of
+text fields. Either field or propertyIdentifier can be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface IntervalQuery {
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
+    rule: IntervalQueryRule;
+}
+/**
+ * Sub-rule used for evaluating an IntervalQuery
+ *
+ * Log Safety: UNSAFE
+ */
+export type IntervalQueryRule = ({
+    type: "allOf";
+} & AllOfRule) | ({
+    type: "match";
+} & MatchRule) | ({
+    type: "anyOf";
+} & AnyOfRule) | ({
+    type: "prefixOnLastToken";
+} & PrefixOnLastTokenRule);
 /**
  * Returns objects based on the existence of the specified field.
  *
@@ -2231,6 +2360,7 @@ export interface LoadObjectSetRequestV2 {
     pageToken?: _Core.PageToken;
     pageSize?: _Core.PageSize;
     excludeRid?: boolean;
+    loadPropertySecurities?: boolean;
     snapshot?: boolean;
     includeComputeUsage?: _Core.IncludeComputeUsage;
 }
@@ -2244,6 +2374,7 @@ export interface LoadObjectSetResponseV2 {
     nextPageToken?: _Core.PageToken;
     totalCount: _Core.TotalCount;
     computeUsage?: _Core.ComputeSeconds;
+    propertySecurities: Array<PropertySecurities>;
 }
 /**
  * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsMultipleObjectTypes endpoint only.
@@ -2258,6 +2389,7 @@ export interface LoadObjectSetV2MultipleObjectTypesRequest {
     pageToken?: _Core.PageToken;
     pageSize?: _Core.PageSize;
     excludeRid?: boolean;
+    loadPropertySecurities?: boolean;
     snapshot?: boolean;
     includeComputeUsage?: _Core.IncludeComputeUsage;
 }
@@ -2282,6 +2414,7 @@ export interface LoadObjectSetV2MultipleObjectTypesResponse {
     interfaceToObjectTypeMappings: Record<InterfaceTypeApiName, InterfaceToObjectTypeMappings>;
     interfaceToObjectTypeMappingsV2: Record<InterfaceTypeApiName, InterfaceToObjectTypeMappingsV2>;
     computeUsage?: _Core.ComputeSeconds;
+    propertySecurities: Array<PropertySecurities>;
 }
 /**
  * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsOrInterfaces endpoint only.
@@ -2403,6 +2536,22 @@ export interface LtQueryV2 {
     propertyIdentifier?: PropertyIdentifier;
     value: PropertyValue;
 }
+/**
+ * The id of a classification or mandatory marking.
+ *
+ * Log Safety: UNSAFE
+ */
+export type MarkingId = LooselyBrandedString<"MarkingId">;
+/**
+ * Matches intervals containing the terms in the query
+ *
+ * Log Safety: UNSAFE
+ */
+export interface MatchRule {
+    query: string;
+    maxGaps?: number;
+    ordered: boolean;
+}
 /**
  * Computes the maximum value for the provided field.
  *
@@ -2535,6 +2684,19 @@ export interface NearestNeighborsQueryText {
 export interface NegatePropertyExpression {
     property: DerivedPropertyDefinition;
 }
+/**
+   * Describes how an object type implements an interface property when a reducer is applied to it. Is missing a
+reduced property implementation to prevent arbitrarily nested implementations.
+   *
+   * Log Safety: UNSAFE
+   */
+export type NestedInterfacePropertyTypeImplementation = ({
+    type: "structFieldImplementation";
+} & InterfacePropertyStructFieldImplementation) | ({
+    type: "structImplementation";
+} & InterfacePropertyStructImplementation) | ({
+    type: "localPropertyImplementation";
+} & InterfacePropertyLocalPropertyImplementation);
 /**
  * Log Safety: UNSAFE
  */
@@ -2765,6 +2927,14 @@ export interface ObjectEdits {
     addedLinksCount: number;
     deletedLinksCount: number;
 }
+/**
+ * Optional features to toggle when generating the object loading response.
+ *
+ * Log Safety: SAFE
+ */
+export interface ObjectLoadingResponseOptions {
+    shouldLoadObjectRids?: boolean;
+}
 /**
  * An object identifier containing an object type API name and primary key.
  *
@@ -3004,6 +3174,7 @@ export interface ObjectSetStreamSubscribeRequest {
     objectSet: ObjectSet;
     propertySet: Array<SelectedPropertyApiName>;
     referenceSet: Array<SelectedPropertyApiName>;
+    objectLoadingResponseOptions?: ObjectLoadingResponseOptions;
 }
 /**
    * The list of object sets that should be subscribed to. A client can stop subscribing to an object set
@@ -3578,6 +3749,15 @@ export interface PreciseDuration {
  * Log Safety: SAFE
  */
 export type PreciseTimeUnit = "NANOSECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS";
+/**
+   * Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for
+the last term. Ordering of the terms in the query is preserved.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface PrefixOnLastTokenRule {
+    query: string;
+}
 /**
  * Returns objects where the specified field starts with the provided value.
  *
@@ -3713,6 +3893,17 @@ export type PropertyLoadLevel = ({
 } & ApplyReducersLoadLevel) | ({
     type: "extractMainValue";
 } & ExtractMainValueLoadLevel);
+/**
+ * All marking requirements applicable to a property value.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface PropertyMarkingSummary {
+    conjunctive?: ConjunctiveMarkingSummary;
+    disjunctive?: DisjunctiveMarkingSummary;
+    containerConjunctive?: ContainerConjunctiveMarkingSummary;
+    containerDisjunctive?: ContainerDisjunctiveMarkingSummary;
+}
 /**
  * Wrapper for numeric formatting options.
  *
@@ -3751,6 +3942,24 @@ export type PropertyOrStructFieldOfPropertyImplementation = ({
 } & StructFieldOfPropertyImplementation) | ({
     type: "property";
 } & PropertyImplementation);
+/**
+ * A disjunctive set of security results for a property value.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface PropertySecurities {
+    disjunction: Array<PropertySecurity>;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export type PropertySecurity = ({
+    type: "propertyMarkingSummary";
+} & PropertyMarkingSummary) | ({
+    type: "unsupportedPolicy";
+} & UnsupportedPolicy) | ({
+    type: "errorComputingSecurity";
+} & ErrorComputingSecurity);
 /**
  * Formatting configuration for timestamp property values.
  *
@@ -3834,6 +4043,7 @@ export interface PropertyV2 {
 | Integer                                                                                                                   | number                                                      | 238940                                                                                           |
 | Long                                                                                                                      | string                                                      | "58319870951433"                                                                                 |
 | MediaReference| JSON encoded MediaReference object                        | {"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}                       |
+| Secured Property Value                                                                                                    | JSON encoded SecuredPropertyValue object                  | {"value": 10, "propertySecurityIndex" : 5}                                                       |
 | Short                                                                                                                     | number                                                      | 8739                                                                                             |
 | String                                                                                                                    | string                                                      | "Call me Ishmael"                                                                                |
 | Struct                                                                                                                    | JSON object of struct field API name -> value               | {"firstName": "Alex", "lastName": "Karp"}                                                          |
@@ -4404,6 +4614,8 @@ export type SearchJsonQueryV2 = ({
 } & IsNullQueryV2) | ({
     type: "containsAnyTerm";
 } & ContainsAnyTermQuery) | ({
+    type: "interval";
+} & IntervalQuery) | ({
     type: "startsWith";
 } & StartsWithQuery);
 /**
@@ -4496,6 +4708,13 @@ export interface SearchOrderingV2 {
     field: PropertyApiName;
     direction?: string;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface SecuredPropertyValue {
+    value?: PropertyValue;
+    propertySecurityIndex?: number;
+}
 /**
    * By default, whenever an object is requested, all of its properties are returned, except for properties of the
 following types:
@@ -5173,6 +5392,26 @@ export interface UnevaluableConstraint {
 export interface UniqueIdentifierArgument {
     linkId?: string;
 }
+/**
+ * A reference to a UniqueIdentifierArgument linkId defined for this action type.
+ *
+ * Log Safety: SAFE
+ */
+export type UniqueIdentifierLinkId = string;
+/**
+   * An override value to be used for a UniqueIdentifier action parameter, instead of
+the value being automatically generated.
+   *
+   * Log Safety: SAFE
+   */
+export type UniqueIdentifierValue = string;
+/**
+ * Indicates the property is backed by a restricted view that does not support property securities.
+ *
+ * Log Safety: SAFE
+ */
+export interface UnsupportedPolicy {
+}
 /**
  * The string must be a valid UUID (Universally Unique Identifier).
  *