跳转至

Unsupported types in OSDK(OSDK 中不支持的类型)

The OSDK generates client-side code for TypeScript, Python, and Java packages; this code represents object types, action types, and functions from the Ontology. Not all data types are currently available in the OSDK; this page lists data types that are not yet supported.

Object types: Unsupported property types

If you use an object type with a property of a type which is listed below, the code generator will skip that property and log the error.

Typescript SDK

The following Typescript SDK property types are unsupported:

  • Cipher
  • Marking
  • Vectors

Python SDK

The following Python SDK property types are unsupported:

  • Cipher
  • Marking
  • Media
  • Struct
  • Vector

Java SDK

The following Java SDK property types are unsupported:

  • TimeSeries
  • Cipher
  • Vector

Action types: Unsupported parameter types

If you use an action type with a parameter of a type mentioned below, the code generator will be unable to create your package. To resolve this, you must remove that action type from the SDK application until support is added for that type.

Python SDK

The following Python SDK parameter types are unsupported:

  • ObjectSet
  • Marking
  • MarkingList

Action types: Unsupported webhook types

Action types with webhooks that use OAuth 2.0 for authentication are not supported. This is because users would be unable to use these action types through the SDK application without first authorizing the outbound application through Foundry (for instance, by first calling the action in a Workshop application).

Functions: Unsupported input parameter types and output types

If you use a function with an input or an output of a type which is listed below, the code generator will fail to generate your package. To resolve this, you must remove that function from the SDK application until such support is added.

Typescript SDK

Function output types

The following Typescript SDK function output types are unsupported:

  • Principal
  • User
  • Notification
  • OntologyEdit
  • ClassificationMarking

Python SDK

Function input parameter types

The following Python SDK function input types are unsupported:

  • ObjectSet
  • AnonymousCustomType
  • ClassificationMarking
  • CustomType
  • GeoShape
  • Group
  • MandatoryControl
  • ModelGraph
  • Notification
  • OntologyEdit
  • Principal
  • Range
  • StringFunctionDateType_ThreeDimensionalAggregation
  • TimeSeries
  • TwoDimensionalAggregation
  • User

Function output types

The following Python SDK function output types are unsupported:

  • ObjectSet
  • AnonymousCustomType
  • ClassificationMarking
  • CustomType
  • GeoShape
  • Group
  • MandatoryControl
  • ModelGraph
  • Notification
  • OntologyEdit
  • Principal
  • Range
  • StringFunctionDateType_ThreeDimensionalAggregation
  • TimeSeries
  • TwoDimensionalAggregation
  • User

Java SDK

Function input parameter types

The following Java SDK function input types are unsupported:

  • AnonymousCustomType
  • ClassificationMarking
  • CustomType
  • GeoShape
  • Group
  • MandatoryControl
  • ModelGraph
  • Notification
  • OntologyEdit
  • Principal
  • Range
  • StringFunctionDateType_ThreeDimensionalAggregation
  • TimeSeries
  • TwoDimensionalAggregation
  • User

Function output types

The following Java SDK function output types are unsupported:

  • AnonymousCustomType
  • ClassificationMarking
  • CustomType
  • GeoShape
  • Group
  • MandatoryControl
  • ModelGraph
  • Notification
  • OntologyEdit
  • Principal
  • Range
  • StringFunctionDateType_ThreeDimensionalAggregation
  • TimeSeries
  • TwoDimensionalAggregation
  • User

OpenAPI Specification

You can export an OpenAPI specification from Developer Console. OpenAPI supports the any type, so you can still use the specification even if some types are unsupported. However, you will need to define the format for those parameters manually.

The following types do not have first-class support in the OpenAPI specification and will be rendered as any:

  • Struct
  • Vector

中文翻译

OSDK 中不支持的类型

OSDK 为 TypeScript、Python 和 Java 包生成客户端代码;这些代码代表本体论(Ontology)中的对象类型、操作类型和函数。目前并非所有数据类型都可在 OSDK 中使用;本页列出了尚未支持的数据类型。

对象类型:不支持的属性类型

如果您使用的对象类型包含以下列出的属性类型,代码生成器将跳过该属性并记录错误。

TypeScript SDK

以下 TypeScript SDK 属性类型不受支持:

  • Cipher
  • Marking
  • Vectors

Python SDK

以下 Python SDK 属性类型不受支持:

  • Cipher
  • Marking
  • Media
  • Struct
  • Vector

Java SDK

以下 Java SDK 属性类型不受支持:

  • TimeSeries
  • Cipher
  • Vector

操作类型:不支持的参数类型

如果您使用的操作类型包含以下提到的参数类型,代码生成器将无法创建您的包。要解决此问题,您必须从 SDK 应用程序中移除该操作类型,直到对该类型的支持被添加。

Python SDK

以下 Python SDK 参数类型不受支持:

  • ObjectSet
  • Marking
  • MarkingList

操作类型:不支持的 Webhook 类型

使用 OAuth 2.0 进行身份验证的 Webhook 的操作类型不受支持。这是因为用户必须先通过 Foundry 授权出站应用程序(例如,先在 Workshop 应用程序中调用该操作),才能通过 SDK 应用程序使用这些操作类型。

函数:不支持的输入参数类型和输出类型

如果您使用的函数包含以下列出的输入或输出类型,代码生成器将无法生成您的包。要解决此问题,您必须从 SDK 应用程序中移除该函数,直到对该类型的支持被添加。

TypeScript SDK

函数输出类型

以下 TypeScript SDK 函数输出类型不受支持:

  • Principal
  • User
  • Notification
  • OntologyEdit
  • ClassificationMarking

Python SDK

函数输入参数类型

以下 Python SDK 函数输入类型不受支持:

  • ObjectSet
  • AnonymousCustomType
  • ClassificationMarking
  • CustomType
  • GeoShape
  • Group
  • MandatoryControl
  • ModelGraph
  • Notification
  • OntologyEdit
  • Principal
  • Range
  • StringFunctionDateType_ThreeDimensionalAggregation
  • TimeSeries
  • TwoDimensionalAggregation
  • User

函数输出类型

以下 Python SDK 函数输出类型不受支持:

  • ObjectSet
  • AnonymousCustomType
  • ClassificationMarking
  • CustomType
  • GeoShape
  • Group
  • MandatoryControl
  • ModelGraph
  • Notification
  • OntologyEdit
  • Principal
  • Range
  • StringFunctionDateType_ThreeDimensionalAggregation
  • TimeSeries
  • TwoDimensionalAggregation
  • User

Java SDK

函数输入参数类型

以下 Java SDK 函数输入类型不受支持:

  • AnonymousCustomType
  • ClassificationMarking
  • CustomType
  • GeoShape
  • Group
  • MandatoryControl
  • ModelGraph
  • Notification
  • OntologyEdit
  • Principal
  • Range
  • StringFunctionDateType_ThreeDimensionalAggregation
  • TimeSeries
  • TwoDimensionalAggregation
  • User

函数输出类型

以下 Java SDK 函数输出类型不受支持:

  • AnonymousCustomType
  • ClassificationMarking
  • CustomType
  • GeoShape
  • Group
  • MandatoryControl
  • ModelGraph
  • Notification
  • OntologyEdit
  • Principal
  • Range
  • StringFunctionDateType_ThreeDimensionalAggregation
  • TimeSeries
  • TwoDimensionalAggregation
  • User

OpenAPI 规范

您可以从开发者控制台导出 OpenAPI 规范。OpenAPI 支持 any 类型,因此即使某些类型不受支持,您仍然可以使用该规范。但是,您需要手动定义这些参数的格式。

以下类型在 OpenAPI 规范中没有一级支持,将被渲染为 any

  • Struct
  • Vector