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

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

get

/crmRestApi/resources/11.13.18.05/objectLinkTypes

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • ObjectLinkTypeAltKey指定した代替一意キーを持つオブジェクト・リンク・タイプを検索します。
      ファインダ変数
      • LinkTypeNumber; string;オブジェクト・リンク・タイプの代替の一意の識別子。
    • ObjectLinkTypeByLinkTypeNumber指定したリンク・タイプ番号を持つオブジェクト・リンク・タイプを検索します。
      ファインダ変数
      • LinkTypeNumber; string;オブジェクト・リンク・タイプの代替の一意の識別子。
    • PrimaryKey指定した主キーを持つオブジェクト・リンク・タイプを検索します。
      ファインダ変数
      • LinkTypeId; 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;行が作成された日付。
    • EnabledFlag; boolean;リンク・タイプを使用してオブジェクト・リンクを作成できるかどうかを示します。
    • InwardCd; string; リンク・タイプの順方向を記述する参照コード。 このフィールドは、短縮名に指定された値から自動生成されます。
    • LastUpdateDate; string; オブジェクト・リンク・タイプが最後に更新された日付。
    • LastUpdateLogin; string; 行を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; オブジェクト・リンク・タイプを最後に更新したユーザー。
    • LinkTypeId; integer;リンク・タイプ識別子。
    • LinkTypeNumber; string;オブジェクト・リンク・タイプの参照番号。
    • 名前、文字列。リンク・タイプのわかりやすい名前。
    • OutwardCd; string; リンク・タイプのアウト・ワード方向を記述する参照コード。 このフィールドは、短縮名に指定された値から自動生成されます。
    • ShortName; string; リンク・タイプの一意の名前。 外側コードと内側コードは短縮名に基づいて自動生成されます。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : objectLinkTypes
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : objectLinkTypes-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    行を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    行が作成された日付。
  • 読取り専用: true
    ユーザーがレコードを削除できるかどうかを示します。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: true
    リンク・タイプを使用してオブジェクト・リンクを作成できるかどうかを示します。
  • タイトル: Inward
    最大長: 30
    リンク・タイプの内向方向を記述する参照コード。 このフィールドは、短縮名に指定された値から自動生成されます。
  • タイトル: Inward Value
    最大長: 80
    内部参照コードの表示値。
  • タイトル: Last Updated Date
    読取り専用: true
    オブジェクト・リンク・タイプが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    オブジェクト・リンク・タイプを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    行を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Link Type ID
    読取り専用: true
    リンク・タイプ識別子。
  • タイトル: Link Type Number
    最大長: 64
    オブジェクト・リンク・タイプの参照番号。
  • タイトル: Name
    最大長: 400
    リンク・タイプのわかりやすい名前。
  • タイトル: Outward
    最大長: 30
    リンク・タイプの外部方向を説明する参照コード。 このフィールドは、短縮名に指定された値から自動生成されます。
  • タイトル: Outward Value
    最大長: 80
    外部参照コードの表示値。
  • タイトル: Short Name
    最大長: 20
    リンク・タイプの一意の名前。 外側コードと内側コードは短縮名に基づいて自動生成されます。
  • 読取り専用: true
    ユーザーがレコードを更新できるかどうかを示します。
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "items": [
        {
            "LinkTypeId": 300100547970175,
            "LinkTypeNumber": "CDRM_4004",
            "Name": "Alpha",
            "ShortName": "Alpha",
            "OutwardCd": "Alpha",
            "InwardCd": "Alpha_I",
            "EnabledFlag": true,
            "CreationDate": "2021-08-18T13:32:25+00:00",
            "CreatedBy": "MHoope",
            "LastUpdateDate": "2021-08-18T13:32:26.684+00:00",
            "LastUpdatedBy": "MHoope",
            "LastUpdateLogin": "C96309E00F0C3562E0531C5CF00AE9FF",
            "OutwardCdMeaning": "Alpha Relation",
            "InwardCdMeaning": "Alpha Inverse Relation",
            "UpdateFlag": true,
            "DeleteFlag": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/CDRM_4004",
                    "name": "objectLinkTypes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/CDRM_4004",
                    "name": "objectLinkTypes",
                    "kind": "item"
                }
            ]
        },
        {
            "LinkTypeId": 300100541277261,
            "LinkTypeNumber": "LT_1",
            "Name": "A Link Type of blocks",
            "ShortName": "BLOCKS",
            "OutwardCd": "ORA_SVC_BLOCKS",
            "InwardCd": "ORA_SVC_BLOCKS_I",
            "EnabledFlag": true,
            "CreationDate": "2021-05-29T15:39:45+00:00",
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "LastUpdateDate": "2021-08-06T11:01:01+00:00",
            "LastUpdatedBy": "AUTOUICASE2",
            "LastUpdateLogin": "C88FD85FC1EABAE8E0531C5CF00AD527",
            "OutwardCdMeaning": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ddd",
            "InwardCdMeaning": "Is Blocked By",
            "UpdateFlag": true,
            "DeleteFlag": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/LT_1",
                    "name": "objectLinkTypes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/LT_1",
                    "name": "objectLinkTypes",
                    "kind": "item"
                }
            ]
        },
...
}
「トップに戻る」