機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 契約
  4. 関連ドキュメント

関連文書の取得

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument

リクエスト

パス・パラメータ
  • これは、Contractsリソースの複合キーを構成し、Contractsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Contractsの特定のインスタンスに移動してハッシュ・キーを取得するために、Contractsコレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 指定された関連文書識別子を持つ関連文書を検索します。
      ファインダ変数:
      • Id; integer;関連ドキュメントの一意の識別子。
    • RelObjPuidAltKey : 代替キーを含む関連ドキュメントを検索 - IDとメジャー・バージョン。
      ファインダ変数:
      • RelatedObjPuid; string.
    • RelatedObjExternalKey : 外部代替キーを持つ関連ドキュメントを検索します。
      ファインダ変数:
      • ExternalKey; string.
      • ExternalSource; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • Attribute26; string; attribute26。
    • BuyOrSell; string; intentフラグ。
    • ChrId; integer;契約ID
    • CleId; integer;契約明細ID
    • Cognomen; string;契約名。
    • ContractHeaderId; integer;契約ヘッダーID。
    • ContractId; integer; Related Document Unique ID
    • ContractMajorVersion; integer;契約メジャー・バージョン。
    • ContractNumber;文字列;関連契約番号
    • ContractTypeDescription; string;契約タイプの説明。
    • ContractTypeId; integer;契約タイプID。
    • CurrencyCode; string;通貨コード。
    • 説明、文字列、説明。
    • EndDate; string;終了日。
    • EstimatedAmount; number;見積金額。
    • ExternalKey;文字列;外部キー
    • ExternalSource; string; External Source(文字列;外部ソース)
    • ID;整数;関連文書ID
    • JtotObject1Code; string; jtot object1コード。
    • ObjectVersionNumber1; integer;オブジェクト・バージョンnumber1。
    • ObjectVersionNumber2; integer;オブジェクト・バージョンnumber2。
    • OrgName; string;組織名。
    • RelatedContractId;整数;関連契約ID
    • RelatedObjPuid; string;関連するオブジェクトPUID。
    • 関係;文字列;関係名
    • RelationshipCode;文字列;関係コード
    • StartDate; string;開始日。
    • StsCode; string;ステータス・コード。
    • タイプ;文字列;タイプ。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

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

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、関連ドキュメントを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com//fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument

レスポンス本文の例

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

{
    "items": [
        {
            "Id": 100100080311423,
            "ChrId": 999990000000147,
            "CleId": null,
            "RelationshipCode": "RELATED_TO",
            "Relationship": "Related to",
            "JtotObject1Code": "OKX_ECMCONTRACT",
            "RelatedContractId": 999990000000146,
            "Attribute26": null,
            "ContractHeaderId": 999990000000146,
            "ContractNumber": "ECM Contract  : 999990000000146",
            "BuyOrSell": "S",
            "ContractMajorVersion": 2,
            "ContractTypeDescription": "Sell : No lines",
            "ContractTypeId": 103,
            "ExternalSource": null,
            "ExternalKey": null,
            "CreateEnableFlag": "true",
            "DeleteEnableFlag": "true",
            "DocumentTypeNew": "Sell : No lines",
            "IntentMeaning": "Sell",
            "ContractId": 100100069436825,
            "CurrencyCode": "USD",
            "ObjectVersionNumber1": 2,
            "StartDate": "2008-08-06",
            "ObjectVersionNumber2": 4,
            "EndDate": "2009-08-06",
            "EstimatedAmount": 14700,
            "Cognomen": "ECM Contract  : 999990000000146",
            "Description": "ECM Contract  : 999990000000146",
            "StsCode": "EXPIRED",
            "OrgName": "Vision Services",
            "Type": "Sell : No lines",
            "RelatedObjPuid": "ROBJ-462863",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/100100080311423",
                    "name": "RelatedDocument",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/100100080311423",
                    "name": "RelatedDocument",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785",
                    "name": "contracts",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/100100080311423/lov/IntentLookupVO1",
                    "name": "IntentLookupVO1",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/100100080311423/lov/RelationshipLookupVA1",
                    "name": "RelationshipLookupVA1",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/100100080311423/lov/ContractNumberVA",
                    "name": "ContractNumberVA",
                    "kind": "collection"
                }
            ]
        },
....
}
「トップに戻る」