添付の更新
patch
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}
リクエスト
パス・パラメータ
- AttachmentUniqID(required): string
これは、添付リソースのコンポジット・キーを構成し、添付のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するために添付の特定のインスタンスに移動するために、添付の収集リソースを問い合せる必要があります。
- SrId(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
AttachmentsDFFVL: array AttachmentsDFFVL
-
AttachmentsPreview: array Attachments Preview
タイトル:
Attachments Preview
添付プレビュー・リソースは、添付ページのプレビューに使用されます。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示す値。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付の作成元となる文書ID。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付の作成元のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付の作成元となる文書バージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・コード(ある場合)。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツの有効期限。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
ファイルのURI。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルのサイズ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
新しい添付ファイルに割り当てる名前。 -
UploadedText: string
タイトル:
Uploaded Text
新規テキスト添付のテキスト・コンテンツ。 -
Uri: string
タイトル:
Uri
最大長:4000
トポロジ・マネージャ・タイプ・アタッチメントのURI。 -
Url: string
タイトル:
Url
最大長:4000
webページ・タイプ添付のURL。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Context Segment
最大長:150
-
__FLEX_Context_DisplayValue: string
タイトル:
Context Segment
-
AttachedDocumentId: integer (int64)
ネストされたスキーマ : internalServiceRequests-Attachment-AttachmentsPreview-item-patch-request
タイプ:
ソースを表示
object
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : internalServiceRequests-Attachment-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
ファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
AttachmentsDFFVL: array AttachmentsDFFVL
-
AttachmentsPreview: array Attachments Preview
タイトル:
Attachments Preview
添付プレビュー・リソースは、添付ページのプレビューに使用されます。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name
読取り専用:true
レコードを作成したユーザーの名前。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示す値。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付の作成元となる文書ID。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付の作成元のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付の作成元となる文書バージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・コード(ある場合)。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツの有効期限。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
ファイルのURI。 -
FileWebImage: 文字列(バイト)
タイトル:
File Web Image
読取り専用:true
ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User
読取り専用:true
レコードを最後に更新したユーザーの名前。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルのサイズ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
新しい添付ファイルに割り当てる名前。 -
UploadedText: string
タイトル:
Uploaded Text
新規テキスト添付のテキスト・コンテンツ。 -
Uri: string
タイトル:
Uri
最大長:4000
トポロジ・マネージャ・タイプ・アタッチメントのURI。 -
Url: string
タイトル:
Url
最大長:4000
webページ・タイプ添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付を作成したユーザーのログイン資格証明。
ネストされたスキーマ : internalServiceRequests-Attachment-AttachmentsDFFVL-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Context Segment
最大長:150
-
__FLEX_Context_DisplayValue: string
タイトル:
Context Segment
-
AttachedDocumentId: integer (int64)
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : internalServiceRequests-Attachment-AttachmentsPreview-item-response
タイプ:
ソースを表示
object
-
ImageHeight: integer
タイトル:
Image Height
読取り専用:true
プレビューされたイメージの高さ。 -
ImageSource: string
タイトル:
Image Source
読取り専用:true
base64でエンコードされたPNG形式のイメージのプレビュー。 -
ImageWidth: integer
タイトル:
Image Width
読取り専用:true
プレビューされたイメージの幅。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PageNum: integer
タイトル:
Page Number
読取り専用:true
プレビュー内のページの番号。
リンク
- AttachmentsDFFVL
-
パラメータ:
- AttachmentUniqID:
$request.path.AttachmentUniqID
- SrId:
$request.path.SrId
(AttachmentsDFFVLのリソース) - AttachmentUniqID:
- AttachmentsPreview
-
パラメータ:
- AttachmentUniqID:
$request.path.AttachmentUniqID
- SrId:
$request.path.SrId
添付プレビュー・リソースは、添付ページのプレビューに使用されます。 - AttachmentUniqID: