機械翻訳について
  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/ContractDocuments/{ContractDocumentsUniqID}

リクエスト

パス・パラメータ
  • これは、契約文書リソースの複合キーを構成し、契約文書のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは契約文書の特定のインスタンスに移動してハッシュ・キーを取得するために、契約文書コレクション・リソースを問い合せる必要があります。
  • これは、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
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : contracts-ContractDocuments-item-response
タイプ: object
ソースを表示
  • タイトル: Asynchronous Upload Tracker Id
    内部共有ドキュメントの非同期トラッカID。
  • タイトル: Attached Document Id
    添付された内部共有文書の一意の識別子。
  • タイトル: Category
    最大長: 30
    内部共有文書が割り当てられるカテゴリのコード。
  • タイトル: Shared
    内部共有文書がコンテンツ・リポジトリで共有されるかどうかを示します。
  • タイトル: Created By
    読取り専用: true
    最大長: 255
    内部共有文書を作成したユーザー。
  • タイトル: Created By User Name
    読取り専用: true
    内部共有文書を作成したユーザーの名前。
  • タイトル: Creation Date
    読取り専用: true
    内部共有文書が作成された日付。
  • タイトル: Type
    最大長: 30
    デフォルト値: FILE
    外部共有文書がファイルまたはURLであるかどうかを識別するコード。
  • タイトル: Description
    最大長: 255
    内部共有文書の摘要。
  • 最大長: 255
    内部共有ドキュメントのDMドキュメントID。
  • タイトル: Dm Folder Path
    最大長: 1000
    内部共有ドキュメントのDmフォルダ・パス。
  • 最大長: 255
    内部共有ドキュメントのDmバージョン番号。
  • タイトル: DownloadInfo
    ファイル添付をプログラムで取得するために使用される情報を含む、文字列として表されるJSONオブジェクト。
  • タイトル: Error Status Code
    内部共有文書のエラー・ステータス・コード。
  • タイトル: Error Status Message
    内部共有文書のエラー・ステータス・メッセージ。
  • タイトル: Expiration Date
    内部共有文書の失効日。
  • タイトル: File Contents
    内部共有ドキュメントのファイル・コンテンツ。
  • タイトル: File Name
    最大長: 2048
    内部共有ドキュメントのファイル名。 ファイル名またはURLが必要です。
  • タイトル: File Url
    内部共有ドキュメントのURLのロケーション。
  • タイトル: File Web Image
    読取り専用: true
    ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。
  • タイトル: Last Update Date
    読取り専用: true
    内部共有文書が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 255
    内部共有ドキュメントを最後に更新したユーザーに関連付けられたログイン・ユーザー名。
  • タイトル: Last Updated By User
    読取り専用: true
    内部共有文書を最後に更新したユーザーの名前。
  • Links
  • タイトル: Title
    内部共有ドキュメントのタイトル。
  • タイトル: Uploaded File Content Type
    内部共有文書のアップロード済ファイル・コンテンツ・タイプ。
  • タイトル: File Size
    内部共有ドキュメントのアップロードされたファイル長。
  • タイトル: Uploaded File Name
    内部共有文書のアップロード済ファイル名。
  • タイトル: Uploaded Text
    内部共有文書のアップロード済テキスト。
  • タイトル: Uri
    最大長: 4000
    内部共有ドキュメントのURI。
  • タイトル: Url
    最大長: 4000
    内部共有ドキュメントのURL。 ファイル名またはURLが必要です。
  • タイトル: User Name
    読取り専用: true
    最大長: 255
    内部共有文書が割り当てられるカテゴリの名前。
トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments00020000000EACED00057708000110F09B46FFDF0000000EACED00057708000110F09B46FFDE

レスポンス本文の例

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

{
    "AttachedDocumentId": 300100560027615,
    "LastUpdateDate": "2022-06-22T09:54:56.543+00:00",
    "LastUpdatedBy": "CONMGR",
    "DatatypeCode": "WEB_PAGE",
    "FileName": null,
    "DmFolderPath": "",
    "DmDocumentId": null,
    "DmVersionNumber": null,
    "Url": "http://www.oracle.com",
    "CategoryName": "OKC_DOCUMENTS_CONTRACT",
    "UserName": "Contract",
    "Uri": null,
    "FileUrl": null,
    "UploadedText": null,
    "UploadedFileContentType": null,
    "UploadedFileLength": null,
    "UploadedFileName": null,
    "ContentRepositoryFileShared": "false",
    "Title": "Vision File Attachment",
    "Description": "Oracle Website",
    "ErrorStatusCode": null,
    "ErrorStatusMessage": null,
    "CreatedBy": "CONMGR",
    "CreationDate": "2022-06-22T09:54:54+00:00",
    "ExpirationDate": null,
    "LastUpdatedByUserName": "Quinn MaxOliv",
    "CreatedByUserName": "Quinn MaxOliv",
    "AsyncTrackerId": null,
    "DownloadInfo": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments/00020000000EACED00057708000110F09B46FFDF0000000EACED00057708000110F09B46FFDE",
            "name": "ContractDocuments",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments/00020000000EACED00057708000110F09B46FFDF0000000EACED00057708000110F09B46FFDE",
            "name": "ContractDocuments",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769",
            "name": "contracts",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments/00020000000EACED00057708000110F09B46FFDF0000000EACED00057708000110F09B46FFDE/enclosure/FileContents",
            "name": "FileContents",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/300100560002769/child/ContractDocuments/00020000000EACED00057708000110F09B46FFDF0000000EACED00057708000110F09B46FFDE/enclosure/FileWebImage",
            "name": "FileWebImage",
            "kind": "other"
        }
    ]
}
「トップに戻る」