添付の更新
patch
/crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment/{AttachmentUniqID}
リクエスト
パス・パラメータ
- AttachmentUniqID(required): string
これは、添付リソースのコンポジット・キーを構成し、添付のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するために添付の特定のインスタンスに移動するために、添付の収集リソースを問い合せる必要があります。
- WoNumber(required): string
作業オーダーの代替一意識別子。 この値はシステム生成で、作業オーダー・プロファイル・オプションSVC_WO_NUMBER PREFIXおよびSVC_WO_NUMBER_FORMATで構成されます。 デフォルトの構成はWO0000000000です。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
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
添付のURL。 -
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
添付のURL。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : customerWorkOrders-Attachment-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
アップロードされたファイルのトラッキングに使用される一意の識別子。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
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
添付のURL。 -
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
添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付に関連付けられているログイン。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。