Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

添付の更新

patch

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment/{AttachmentUniqID}

リクエスト

パス・パラメータ

AttachmentUniqID(required): string

これは、商談添付リソースの複合キーを構成し、商談添付のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは商談添付の特定のインスタンスに移動してハッシュ・キーを取得するために、商談添付コレクション・リソースを問い合せる必要があります。
OptyNumber(required): string

商談の一意の代替識別子。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリの名前。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付が共有されているかどうかを示します。デフォルト値はfalseです。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

データのタイプを示すコード。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

添付文書の一意の識別子。
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。

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the data.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : opportunities-Attachment-item-response

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

アップロードされたファイルのトラッキングに使用される一意の識別子。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付の一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリの名前。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付が共有されているかどうかを示します。デフォルト値はfalseです。
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

添付文書の一意の識別子。
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

添付に関連付けられているログイン。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The login of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the data.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The login of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、商談添付を更新する方法を示しています。

FILEタイプの添付の更新

cURLコマンド

curl --user sales_cloud_user @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_117503/child/Attachment/00020000000EACED00057708000110F08228F0640000000EACED00057708000110F08228F063

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{      
"CategoryName": "MISC",
"DatatypeCode": "FILE",
"FileContents": "VGVzdCBjb250ZW50IHVwZGF0ZWQgMTIz",
"Title" : "Sample File attachment 07/28 test 123 Updated",
"FileName": "New_Test_Attachment_Updated.txt"
}

レスポンス本文の例

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

{
   "LastUpdateDate":"2015-07-28T03:24:07-07:00",
   "LastUpdatedBy":"SALES_ADMIN",
   "EntityName":"MOO_OPTY",
   "Pk1Value":"300100054323876",
   "Pk2Value":null,
   "Pk3Value":null,
   "Pk4Value":null,
   "Pk5Value":null,
   "DatatypeCode":"FILE",
   "FileName":"New_Test_Attachment_Updated.txt",
   "DmFolderPath":null,
   "DmDocumentId":"UCMFA004839",
   "DmVersionNumber":"4040",
   "Url":null,
   "CategoryName":"MISC",
   "UserName":"Miscellaneous",
   "Uri":null,
   "EntAppShortName":null,
	"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a21564?&XFND_SCHEME_ID=1&XFND_CERT_FP=09B5C8AE7FFF1BC26FF8FFE8603DB27633015773&XFND_RANDOM=-5629498665627234903&XFND_EXPIRES=1501846632749&XFND_SIGNATURE=mgAmTnh0VhJgFOCQetpr-F7qla0ijIUVltQFXu~1LCfMi4QhqUViwdSgSa5RF8i2dkkjRztxHZIcoXX51drmgtI24txYNYKJeFmnhWrKr3volf~nLqJfwKvJiGigTK4hIsfoYVJoNS1imIdKFGiGy7bB0AqLemCrTCcHoIHEj23FDSqyJ31m48kwTa7pHUcXVmPxr0h-P177stprfjsfBoxh4bHQaLZwAHOVxV4UHmpfxNb1GbX6q9LOTFdSnvE2mEbGdxs98sf1Rv5LKsTL3aU~KzmS-JeizMv0t8IRrBJi6sOJs-seWAFxvOrRAvtXYpVdCBj6Axsq9PyoP8LXDg__&Id=21564&download",
  "UploadedText":null,
   "UploadedFileContentType":"text/plain",
   "UploadedFileLength":24,
   "UploadedFileName":"New_Test_Attachment_Updated.txt",
   "ContentRepositoryFileShared":"false",
   "Title":"Sample File attachment 07/28 test 123 Updated",
   "Description":"",
   "ErrorStatusCode":null,
   "ErrorStatusMessage":null,
   "CreatedBy":"SALES_ADMIN",
   "CreationDate":"2015-07-28T03:24:05-07:00",
 ... 
 }

TEXTタイプの添付の更新

cURLコマンド

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{     
"CategoryName": "MISC",
"DatatypeCode": "TEXT",
"UploadedText": "Sample Text 07/28 test 1111 Updated"
}

レスポンス本文の例

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

{
  "LastUpdateDate" : "2015-07-28T03:28:18-07:00",
  "LastUpdatedBy" : "SALES_ADMIN",
  "EntityName" : "MOO_OPTY",
  "Pk1Value" : "300100054323876",
  "Pk2Value" : null,
  "Pk3Value" : null,
  "Pk4Value" : null,
  "Pk5Value" : null,
  "DatatypeCode" : "TEXT",
  "FileName" : "Sample Text 07/28 test 1111",
  "DmFolderPath" : null,
  "DmDocumentId" : "UCMFA004840",
  "DmVersionNumber" : "4041",
  "Url" : null,
  "CategoryName" : "MISC",
  "UserName" : "Miscellaneous",
  "Uri" : null,
  "EntAppShortName" : null, 
  "FileUrl": 
"/content/conn/FusionAppsContentRepository/uuid/dDocID%3a21577?XFND_SCHEME_ID=1&XFND_CERT_FP=09B5C8AE7FFF1BC26FF8FFE8603DB27633015773&XFND_RANDOM=1538444565440720007&XFND_EXPIRES=1501852824575&XFND_SIGNATURE=dTvPLbcQLKUrLCDNo1fh4wfO~gd~yuSW-yX2BAN1zXjMJxZOflWPDpfN2fi3LsD7Uqdi9J3MHnLrBkBQ7DuDwgg8DRi8lRe5B-wZMrFhnFbQmsC7Y94~gdfMi9kfnGbuFhiZFlwnMpUrOyox-9fdq8Y2swZp8gOHa6KNg-LwaYTqSBlnoocvATPyJhrwj5JJSP1spNLvkRhz0XRWL8qES3dUzOh1aydVSzUjHjzuhxB-c13F4OGsbuKUtloWjt5qVlAiLF9wrk9F40WqtCy71qAy3Y5v9WPyvogvcz7d~q4xZbyXtiIXrYJVQfOclT1RiK-N55-xW7pA2VJYm8HdlQ__&Id=21577&download",
  "UploadedText" : null,
  "UploadedFileContentType" : "text/plain",
  "UploadedFileLength" : 38,
  "UploadedFileName" : "SALES_ADMIN-1438080896000.txt",
  "ContentRepositoryFileShared" : "false",
  "Title" : "Sample Text 07/28 test 1111",
  "Description" : "",
  "ErrorStatusCode" : null,
  "ErrorStatusMessage" : null,
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2015-07-28T03:28:17-07:00",
 ...
}

WEB_URLタイプのアタッチメントの更新

cURLコマンド

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{      
"CategoryName": "MISC",
"DatatypeCode": "WEB_PAGE",
"Url": "http://www.oracle.com"
}

レスポンス本文の例

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

{
  "LastUpdateDate": "2017-08-04T13:20:38.262+00:00",
  "LastUpdatedBy": "SALES_ADMIN",
  "DatatypeCode": "WEB_PAGE",
  "FileName": null,
  "DmFolderPath": null,
  "Url": "http://www.oracle.com",
  "CategoryName": "MISC",
  "UserName": null,
  "Url" : "http://www.google.com",
  "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": "2017-08-04T13:20:38.206+00:00",
  "ExpirationDate": null,
  ...
}

「トップに戻る」