機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. 関係タイプ

すべての関係タイプの取得

get

/crmRestApi/resources/11.13.18.05/relationshipTypes

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定した主キーを持つ関係タイプを検索します。
      ファインダ変数:
      • LookupCode; string;指定された参照コードを持つ関係タイプを検索します。
      • LookupType; string;指定した参照タイプの関係タイプを検索します。
      • RelationshipTypeId; integer; 関係タイプの一意の識別子。
    • RoleForSubjectObjectFinder : 関係ロールを検索します。
      ファインダ変数:
      • bindObjectType; string;指定したオブジェクト型との関係を検索します。
      • bindRelationshipCode; string;指定したリレーションシップ・コードとの関係を検索します。
      • bindRelationshipType; string;指定した関係タイプとの関係を検索します。
      • bindSubjectType; string;指定されたサブジェクト・タイプとの関係を検索します。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AllowCircularRelationships; string; この関係タイプを使用して循環関係が許可されるかどうかを示します。
    • BackwardRelationshipCode; string; SUPPLIER_OFのような関係を記述するために使用されるバック・ワード関係コード。
    • CreatedByModule; string; レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
    • Description; string;関係ロールの説明。
    • DirectionCode; string; DIRECTION_CODE参照タイプによって検証される方向コード。 親の場合はP、子の場合はC、方向でない場合はN。
    • EndDateActive; string;関係ロールが終了する日付。
    • ForwardRelationshipCode; string; CUSTOMER_OFのような関係を記述するために使用されるフォワード関係コード。
    • 言語、文字列、関係ロール参照言語。
    • LookupCode; string;関係ロール・コード。
    • LookupType; string; ロール参照コードHZ_RELATIONSHIP_ROLE。
    • 内容;文字列;関係ロールの意味。
    • ObjectType; string; 関係タイプのオブジェクト・タイプ。
    • RelationshipType; string; CUSTOMER_SUPPLIERのような関係タイプの名前。
    • RelationshipTypeId; integer; 関係タイプの一意の識別子。
    • ロール、文字列。関係タイプおよびフレーズに基づく一意の関係ロール参照コード。 HZ_RELATIONSHIP_ROLE参照タイプの意味は複数ロールで、説明は単数ロールです。
    • SetId; integer;セットの一意の識別子、値0。
    • SourceLang; string;関係ロールのソース言語。
    • StartDateActive; string;関係ロールが開始する日付。
    • ステータス;文字列;関係タイプが非アクティブかアクティブかを示し、I(非アクティブ)、A(アクティブ)などの値を使用します。
    • SubjectType; string; 関係タイプのサブジェクト・タイプ。 この属性は一時フィールドであるため、ファインダとして使用できません。 この属性をファインダとして使用すると、レスポンスはエラーを返します。
    • Tag; string;関係のロール・タグ。
    • TerritoryCode; string;関係ロールの地域コード。
    • ViewApplicationId; integer; 関係ロール参照コードのビュー・アプリケーションの一意の識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : relationshipTypes
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : relationshipTypes-item-response
タイプ: object
ソースを表示
  • タイトル: Circular
    読取り専用: true
    最大長: 1
    この関係タイプを使用して循環関係が許可されるかどうかを示します。
  • 読取り専用: true
    最大長: 30
    SUPPLIER_OFなどの関係を記述するために使用されるバック・ワード関係コード。
  • 読取り専用: true
    最大長: 150
    レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
  • タイトル: Description
    読取り専用: true
    最大長: 240
    関係ロールの説明。
  • 読取り専用: true
    最大長: 30
    DIRECTION_CODE参照タイプによって検証される方向コード。 親の場合はP、子の場合はC、方向でない場合はN。
  • 読取り専用: true
    関係ロールが終了する日付。
  • 読取り専用: true
    最大長: 30
    CUSTOMER_OFなどの関係を記述するために使用されるフォワード関係コード。
  • 読取り専用: true
    最大長: 30
    関係ロール参照言語。
  • Links
  • 読取り専用: true
    最大長: 30
    関係ロール・コード。
  • 読取り専用: true
    最大長: 30
    ロール参照コードHZ_RELATIONSHIP_ROLE。
  • 読取り専用: true
    最大長: 80
    関係ロールの意味。
  • タイトル: Object Type
    読取り専用: true
    最大長: 30
    関係タイプのオブジェクト・タイプ。
  • タイトル: Relationship Type
    読取り専用: true
    最大長: 30
    関係タイプの名前(CUSTOMER_SUPPLIERなど)。
  • 読取り専用: true
    関係タイプの一意の識別子。
  • 読取り専用: true
    最大長: 30
    関係タイプおよびフレーズに基づく一意の関係ロール参照コード。 HZ_RELATIONSHIP_ROLE参照タイプの意味は複数ロールで、説明は単数ロールです。
  • 読取り専用: true
    セットの一意の識別子、値0。
  • 読取り専用: true
    最大長: 4
    関係ロールのソース言語。
  • 読取り専用: true
    関係ロールが開始する日付。
  • 読取り専用: true
    最大長: 1
    関係タイプが非アクティブかアクティブかを示し、I(非アクティブ)、A(アクティブ)などの値があります。
  • タイトル: Subject Type
    読取り専用: true
    最大長: 30
    関係タイプのサブジェクト・タイプ。 この属性は一時フィールドであるため、ファインダとして使用できません。 この属性をファインダとして使用すると、レスポンスはエラーを返します。
  • 読取り専用: true
    最大長: 150
    関係のロール・タグ。
  • 読取り専用: true
    最大長: 2
    関係ロールのテリトリ・コード。
  • 読取り専用: true
    関係ロール参照コードのビュー・アプリケーションの一意の識別子。
「トップに戻る」