機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. サービス・リクエスト
  4. 添付

添付を取得

get

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}

リクエスト

パス・パラメータ
  • これは、添付リソースのコンポジット・キーを構成し、添付のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するために添付の特定のインスタンスに移動するために、添付の収集リソースを問い合せる必要があります。
  • サービス・リクエストの識別に使用される一意の番号。 サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。 たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : serviceRequests-Attachment-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : AttachmentsDFFVL
タイプ: array
ソースを表示
ネストされたスキーマ : 添付プレビュー
タイプ: array
タイトル: Attachments Preview
添付プレビュー・リソースは、添付ページのプレビューに使用されます。
ソースを表示
ネストされたスキーマ : serviceRequests-Attachment-AttachmentsDFFVL-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : serviceRequests-Attachment-AttachmentsPreview-item-response
タイプ: object
ソースを表示
  • タイトル: Image Height
    読取り専用: true
    プレビューされたイメージの高さ。
  • タイトル: Image Source
    読取り専用: true
    base64でエンコードされたPNG形式のイメージのプレビュー。
  • タイトル: Image Width
    読取り専用: true
    プレビューされたイメージの幅。
  • Links
  • タイトル: Page Number
    読取り専用: true
    プレビュー内のページの番号。
リンク
AttachmentsDFFVL
パラメータ:
  • AttachmentUniqID: $request.path.AttachmentUniqID
  • SrNumber: $request.path.SrNumber
(AttachmentsDFFVLのリソース)
AttachmentsPreview
パラメータ:
  • AttachmentUniqID: $request.path.AttachmentUniqID
  • SrNumber: $request.path.SrNumber
添付プレビュー・リソースは、添付ページのプレビューに使用されます。
トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行してアタッチメントを取得する方法を示しています。

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/Attachment/00020000000EACED00057708000110F07F66E0BD0000000EACED00057708000110F07F66E0BC HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200: OK
Date: Thu, 06 Oct 2016 10:30:00 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"LastUpdateDate": "2016-09-13T15:38:13-07:00"
"LastUpdatedBy": "SALES_ADMIN"
"DatatypeCode": "WEB_PAGE"
"FileName": null
"DmFolderPath": null
"Url": "http://www.oracle.com"
"CategoryName": "MISC"
"UserName": "Miscellaneous"
"Uri": null
"FileUrl": null
"UploadedText": null
"UploadedFileContentType": null
"UploadedFileLength": null
"UploadedFileName": null
"ContentRepositoryFileShared": "false"
"Title": "http://www.oracle.com"
"Description": ""
"ErrorStatusCode": null
"ErrorStatusMessage": null
"CreatedBy": "SALES_ADMIN"
"CreationDate": "2016-09-13T15:37:36-07:00"
"ExpirationDate": null
"links": 
[
4]
0:  
{
"rel": "self"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/Attachment/00020000000EACED00057708000110F07F66E0BD0000000EACED00057708000110F07F66E0BC"
"name": "Attachment"
"kind": "item"
}
-
1:  
{
"rel": "canonical"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/Attachment/00020000000EACED00057708000110F07F66E0BD0000000EACED00057708000110F07F66E0BC"
"name": "Attachment"
"kind": "item"
}
-
2:  
{
"rel": "parent"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002"
"name": "serviceRequests"
"kind": "item"
}
-
3:  
{
"rel": "enclosure"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/Attachment/00020000000EACED00057708000110F07F66E0BD0000000EACED00057708000110F07F66E0BC/enclosure/FileContents"
"name": "FileContents"
"kind": "other"
}
-
-
}
「トップに戻る」