機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. オブジェクト・リンク

すべてのオブジェクト・リンクの取得

get

/crmRestApi/resources/11.13.18.05/objectLinks

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • ObjectLinkAltKey指定した代替一意キーを持つオブジェクト・リンクを検索します。
      ファインダ変数
      • LinkNumber; string;オブジェクト・リンクの代替の一意の識別子。
    • ObjectLinkByLinkNumber指定した代替一意キーを持つオブジェクト・リンクを検索します。
      ファインダ変数
      • LinkNumber; string;オブジェクト・リンクの代替の一意の識別子。
    • PrimaryKey指定した主キーを持つオブジェクト・リンクを検索します。
      ファインダ変数
      • LinkId; integer;オブジェクト・リンクの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string; 行を作成したユーザー。
    • CreationDate; string;行が作成された日付。
    • InwardCd; string; リンク・タイプの順方向を記述する参照コード。 このフィールドは、短縮名に指定された値から自動生成されます。
    • InwardCdMeaning; string;オブジェクト・リンクに使用されるリンク・タイプの内部参照コードの表示値。
    • LastUpdateDate; string; オブジェクト・リンク・タイプが最後に更新された日付。
    • LastUpdateLogin; string; 行を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; オブジェクト・リンク・タイプを最後に更新したユーザー。
    • LinkId; integer;オブジェクト・リンク識別子。
    • LinkNumber; string;オブジェクト・リンクの参照番号。
    • LinkTypeNumber; string; ソース・オブジェクトとターゲット・オブジェクト間のリンクのタイプ。
    • LinkTypeShortName; string; リンク・タイプの一意の名前。 外側コードと内側コードは短縮名に基づいて自動生成されます。
    • 名前、文字列。リンク・タイプのわかりやすい名前。
    • ObjectReference; string; SourceObjectReferenceとTargetObjectReferenceの両方を問い合せるために使用できる参照値。
    • ObjectTypeCd; string; オブジェクトのタイプを示す参照コード。 これは、SourceObjectTypeCdとTargetObjectTypeCdの両方を問い合せるために使用できます。
    • OutwardCd; string; リンク・タイプのアウト・ワード方向を記述する参照コード。 このフィールドは、短縮名に指定された値から自動生成されます。
    • OutwardCdMeaning; string;オブジェクト・リンクに使用されるリンク・タイプのアウト・ワード参照コードの表示値。
    • SourceObjectId; integer;ソース・オブジェクトの識別子。
    • SourceObjectReference; string;ソース・オブジェクトの参照値。
    • SourceObjectTypeCd; string; ソース・オブジェクトのタイプを示す参照コード。
    • SourceObjectTypeCdMeaning; string;ソース・オブジェクト・タイプ参照コードの表示値。
    • TargetObjectId; integer; ターゲット・オブジェクトの一意の識別子。
    • TargetObjectReference; string;ターゲット・オブジェクトの参照値。
    • TargetObjectTypeCd; string; ターゲット・オブジェクトのタイプを示す参照コード。
    • TargetObjectTypeCdMeaning; string;ターゲット・オブジェクト・タイプ参照コードの表示値。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行することによって、すべてのオブジェクト・リンクを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinks

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "items": [
        {
            "LinkId": 300100547490303,
            "LinkNumber": "CDRM_0000014009",
            "SourceObjectReference": "SR0000081148",
            "SourceObjectTypeCd": "ServiceRequest",
            "SourceObjectTypeCdMeaning": "Service Request",
            "SourceObjectId": null,
            "TargetObjectReference": "SR0000011019",
            "TargetObjectTypeCd": "ServiceRequest",
            "TargetObjectTypeCdMeaning": "Service Request",
            "TargetObjectId": null,
            "LinkTypeNumber": "LT_1",
            "CreationDate": "2021-08-16T15:06:13+00:00",
            "CreatedBy": "AUTOUICASE2",
            "LastUpdateDate": "2021-08-16T15:06:13.126+00:00",
            "LastUpdatedBy": "AUTOUICASE2",
            "LastUpdateLogin": "C9631A5C51BC3578E0531C5CF00AC03E",
            "Name": "A Link Type of blocks",
            "OutwardCd": "ORA_SVC_BLOCKS",
            "InwardCd": "ORA_SVC_BLOCKS_I",
            "InwardCdMeaning": "Is Blocked By",
            "LinkTypeShortName": "BLOCKS",
            "ObjectTypeCd": null,
            "ObjectReference": null,
            "UpdateFlag": true,
            "DeleteFlag": true,
...
        }
    ]
}
「トップに戻る」