メタデータ
ビジネス オブジェクトのフィールド、リレーションシップ、関連するビジネス オブジェクトのフィールド、保存された検索名、テンプレート名、クイック アクション名のリストなどの詳細を取得します。
メタデータの読み取り
メタデータ API を実行した後に返される応答では、詳細はさまざまな OData 要素にグループ化されます。たとえば、 NavigationProperty 要素には Relationship の詳細が含まれ、 Actions 要素にはテンプレートまたはクイック アクションの詳細が含まれます。
次の表は、ISM 要素にマップされる OData 要素を示しています。
OData 標準要素 | ISM 固有の要素 |
|---|---|
ナビゲーションプロパティ | 人間関係 |
アクション | テンプレートとクイックアクション |
物件名 | フィールド |
関数 | 保存した検索 |
ベース URL:
https://{tenant url}/api/odata/{business object name}/$metadata
ビジネス オブジェクト名の末尾に「s」が付いていることを確認します。
インシデントのメタデータを取得する例を次に示します。
メールアドレス | https://{tenant url}/api/odata/incidents/$metadata |
|---|---|
方法 | 得る |
ヘッダー名 | 認証: JTW トークン/セッション キー/REST API キー |
ステータスコード | 200 |
レスポンスペイロード | <?xml version="1.0" encoding="utf-8"?> <edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx"> <edmx:DataServices> <Schema Namespace="MetaData" xmlns="http://docs.oasis-open.org/odata/ns/edm"> <EntityType Name="frs_knowledge"> <Key> <PropertyRef Name="RecId" /> </Key> <Property Name="FRS_KnowledgeType" Type="Edm.String" MaxLength="30" Unicode="false" /> <Property Name="RecId" Type="Edm.String" Nullable="false" MaxLength="32" Unicode="false" /> <Property Name="LastModDateTime" Type="Edm.DateTimeOffset" /> <Property Name="LastModBy" Type="Edm.String" MaxLength="200" /> <Property Name="CreatedDateTime" Type="Edm.DateTimeOffset" /> <Property Name="CreatedBy" Type="Edm.String" MaxLength="200" /> <Property Name="OwnerType" Type="Edm.String" MaxLength="30" Unicode="false" /> <Property Name="Owner_Valid" Type="Edm.String" MaxLength="32" Unicode="false" /> </EntityType> <EntityType Name="employee"> <Key> <PropertyRef Name="RecId" /> </Key> <EntityType Name="frs_myitem"> <Key> <PropertyRef Name="RecId" /> </Key> <Property Name="RecId" Type="Edm.String" Nullable="false" MaxLength="32" ユニコード="false" /> <Property Name="LastModDateTime" Type="Edm.DateTimeOffset" /> <Property Name="LastModBy" Type="Edm.String" MaxLength="200" /> <Property Name="CreatedDateTime" Type="Edm.DateTimeOffset" /> <Property Name="CreatedBy" Type="Edm.String" MaxLength="200" /> <Property Name="OwnerType" Type="Edm.String" MaxLength="30" Unicode="false" /> <Property Name="Owner_Valid" Type="Edm.String" MaxLength="32" Unicode="false" /> <Property Name="Owner" Type="Edm.String" MaxLength="200" /> <Property Name="OwnerTeam_Valid" Type="Edm.String" MaxLength="32" ユニコード="false" /> </EntityType> <EntityType Name="journal"> <Key> <Function Name="My_Team's_Active_Incidents_All_Tasks_Completed"> <Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false"> <Annotation Term="Org.OData.Core.V1.OptionalParameter"> <Record> <PropertyValue Property="DefaultValue" String="c5d882f8-918d-466a-9048-02c3449bc7f0" /> </Record> </Annotation> </Parameter> <ReturnType Type="Edm.ComplexType" /> </Function> <NavigationProperty Name="IncidentAssociatedEscalationWatch" タイプ="コレクション(MetaData.frs_data_escalation_watch)"> <OnDelete Action="Cascade" /> </NavigationProperty> <NavigationProperty Name="IncidentContainsTask" Type="Collection(MetaData.task)"> <OnDelete Action="Cascade" /> </NavigationProperty> <NavigationProperty Name="IncidentAssociatesCI" Type="Collection(MetaData.ci)"> <OnDelete Action="Cascade" /> </NavigationProperty> <NavigationProperty Name="IncidentAssociatedSoftwareAction" タイプ="コレクション(MetaData.softwareaction)"> <OnDelete Action="Cascade" /> </EntityType> <Action Name="New_Document_Article"> <Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false"> <Annotation Term="Org.OData.Core.V1.OptionalParameter"> <Record> <PropertyValue Property="DefaultValue" String="1e16a70f-cea5-4e56-bb6c-000eecfa5e42" /> </Record> </Annotation> </Parameter> <Parameter Name="ActionParams" Type="Edm.ComplexType"> <Annotation Term="Org.OData.Core.V1.OptionalParameter" /> </Parameter> <Parameter Name="PromptParams" Type="Edm.ComplexType"> <Annotation Term="Org.OData.Core.V1.OptionalParameter" /> </Action> <Action Name="Create_Assignment"> <Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false"> <Annotation Term="Org.OData.Core.V1.OptionalParameter"> <Record> <PropertyValue Property="DefaultValue" String="0d260a06-d203-4c72-8929-22a09038cefc" /> </Record> </Annotation> </Parameter> <Parameter Name="ActionParams" Type="Edm.ComplexType"> <Annotation Term="Org.OData.Core.V1.OptionalParameter" /> </Action> <Action Name="Resolve_Incident"> <Parameter Name="ActionId" Type="Edm.String" Nullable="false" Unicode="false"> <Annotation Term="Org.OData.Core.V1.OptionalParameter"> <Record> <PropertyValue Property="DefaultValue" String="43a31840-2689-405f-88cc-a63a2539be99" /> </Record> </Annotation> </Parameter> <Parameter Name="ActionParams" Type="Edm.ComplexType"> <Annotation Term="Org.OData.Core.V1.OptionalParameter" /> </Parameter> <Parameter Name="PromptParams" Type="Edm.ComplexType"> <Annotation Term="Org.OData.Core.V1.OptionalParameter" /> </Parameter> <Parameter Name="ShouldSave" Type="Edm.String" Unicode="false"> <Annotation Term="Org.OData.Core.V1.OptionalParameter" /> </Parameter> <ReturnType Type="Edm.ComplexType" /> </Action> |
