Metadata reference(元数据参考)¶
An interface is represented in the Ontology by the following metadata:
- RID: An automatically generated unique identifier for every resource in Palantir. An interface’s RID will be referenced in error messages across the platform.
- Icon: A picture and color used as a visual identifier that will appear in applications when a user views this interface. Interfaces have dashed lines around their icons to visually distinguish them from object type icons. For example, the building icon surrounded by dashed lines may be used to depict the
Facilityinterface. - Display name: The name shown to anyone accessing this interface in user applications. For example, the display name for the
Facilityinterface may be "Facility". - Description: Explanatory text about the interface that anyone can read in user applications. For example, the description of the
Facilityinterface may be "An abstract object type interface for representing airline facilities". - API name: The name used when referring to the interface programmatically in code. For example, the API name of the
Facilityinterface may befacility. - Status: A signal to users and Ontology builders about where in the development process the interface stands. It can be
active,experimental,example, ordeprecated. By default, theFacilityinterface will have theexperimentalstatus. Learn more about statuses. - Searchable: A boolean value that specifies whether the interface is searchable. Searchable interfaces enable users to load or search all objects of the interface at once. Searchable interfaces are limited to 50 implementing object types, whereas non-searchable interfaces are limited to 1,000. By default, the
Facilityinterface will be searchable.
中文翻译¶
元数据参考¶
接口在本体论(Ontology)中通过以下元数据表示:
- RID: Palantir 中每个资源自动生成的唯一标识符。接口的 RID 将在平台各处的错误消息中被引用。
- 图标: 用作视觉标识的图片和颜色,当用户查看此接口时,该图标会出现在应用程序中。接口的图标带有虚线边框,以便在视觉上与对象类型图标区分。例如,带有虚线边框的建筑图标可用于表示
Facility接口。 - 显示名称: 在用户应用程序中访问此接口时显示给用户的名称。例如,
Facility接口的显示名称可能是"设施"。 - 描述: 关于接口的解释性文本,任何用户都可在应用程序中阅读。例如,
Facility接口的描述可能是"用于表示航空设施设施的抽象对象类型接口"。 - API 名称: 在代码中以编程方式引用接口时使用的名称。例如,
Facility接口的 API 名称可能是facility。 - 状态: 向用户和本体构建者指示接口在开发过程中所处阶段的信号。状态可以是
active(活跃)、experimental(实验性)、example(示例)或deprecated(已弃用)。默认情况下,Facility接口的状态为experimental。了解更多关于状态的信息。 - 可搜索: 一个布尔值,指定接口是否可搜索。可搜索接口允许用户一次性加载或搜索该接口的所有对象。可搜索接口限制为最多 50 个实现对象类型,而不可搜索接口限制为最多 1,000 个。默认情况下,
Facility接口为可搜索。