この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Document

ユーザがアップロードしたファイルを表します。Attachment レコードと異なり、ドキュメントは親オブジェクトに添付されません。

サポートされているコール

create()、delete()、describeSObjects()、getDeleted()、getUpdated()、query()、retrieve()、search()、undelete()、update()、upsert()

特別なアクセスルール

ドキュメントに対する「編集」権限と、ドキュメントを含む Folder に対する適切なアクセス権およびその Folder 内でドキュメントを作成したり更新したりするための適切なアクセス権が割り当てられている必要があります。

項目

項目 詳細
AuthorId
型
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
ドキュメントを担当する User の ID。
これはリレーション項目です。
リレーション名
Author
リレーション種別
Lookup
参照先
User
Body
型
base64
プロパティ
Create、Nillable、Update
説明
必須。符号化されたファイルデータ。指定されている場合、URL を指定しないでください。
BodyLength
型
int
プロパティ
Filter、Group、Sort
説明
ファイルのサイズ (バイト単位)。
ContentType
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
コンテンツの種類。表示ラベルは [MIME タイプ] です。最大 120 文字です。

組織で [HTML で添付ファイルまたはドキュメントレコードとしてアップロードすることを許可しない] セキュリティ設定が有効になっている場合は、.htm、.html、.htt、.htx、.mhtm、.mhtml、.shtm、.shtml、.acgi、.svg の拡張子を持つファイルのアップロードはできません。

Description
型
textarea
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
ドキュメントのテキストによる説明。最大 255 文字です。
DeveloperName
型
string
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
API のオブジェクトの一意の名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更はサブスクライバーの組織で反映されます。表示ラベルは [ドキュメントの一意の名前] です。

大規模データセットを作成する場合、必ず各レコードの一意の DeveloperName を指定してください。DeveloperName が指定されていないと、Salesforce で各レコードの DeveloperName を生成している間にパフォーマンスが低下する可能性があります。

メモ

FolderId
型
reference
プロパティ
Create、Filter、Group、Sort、Update
説明
必須。ドキュメントを含む Folder の ID。
これはリレーション項目です。
リレーション名
Folder
リレーション種別
Lookup
参照先
Folder、User
IsBodySearchable
型
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
オブジェクトの内容を、SOSL FIND コールを使用して検索可能かどうかを示します。ALL FIELDS 検索グループには、検索可能な項目の内容が含まれます。
IsDeleted
型
boolean
プロパティ
Defaulted on create、Filter
説明
オブジェクトがごみ箱に移動したか (true)、否か (false) を示します。表示ラベルは Deleted です。
IsInternalUseOnly
型
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
オブジェクトを内部でのみ使用できるか (true)、否か (false) を示します。表示ラベルは [社外秘フラグ] です。
IsPublic
型
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
オブジェクトを外部で使用できるか (true)、否か (false) を示します。表示ラベルは [外部参照可] です。
Keywords
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
キーワード。最大 255 文字です。
LastReferencedDate
型
datetime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードに関連するレコードを最後に表示したときのタイムスタンプ。
LastViewedDate
型
datetime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードを最後に表示したときのタイムスタンプ。この値が null の場合、このレコードは参照 (LastReferencedDate) されただけで、表示はされていない可能性があります。
Name
型
string
プロパティ
Create、Filter、Group、idLookup、Sort、Update
説明
必須。ドキュメントの名前。表示ラベルは [ドキュメント名] です。
NamespacePrefix
型
string
プロパティ
Filter、Group、Sort、Nillable
説明
このオブジェクトと関連付けられた名前空間プレフィックス。管理パッケージを作成する Developer Edition 組織ごとに一意の名前空間プレフィックスがあります。最大 15 文字です。namespacePrefix__componentName 表記を使用して、管理パッケージのコンポーネントを参照できます。

名前空間プレフィックスには、次のいずれかの値があります。

  • Developer Edition 組織では、インストールされた管理パッケージにオブジェクトが含まれていない限り、名前空間プレフィックスをサポートするすべてのオブジェクトで NamespacePrefix が組織の名前空間プレフィックスに設定されます。その場合、オブジェクトにはインストールされた管理パッケージの名前空間プレフィックスが付きます。この項目の値は、パッケージ開発者の Developer Edition 組織の名前空間プレフィックスです。
  • Developer Edition 組織でない場合、NamespacePrefix は、インストールされた管理パッケージの一部であるオブジェクトでのみ設定されます。その他のオブジェクトには名前空間プレフィックスがありません。
Type
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
ドキュメントのファイルのデータ型。通常、値は、ドキュメントの種類 (pdf または jpg など) のファイル拡張子に一致します。表示ラベルは [ファイル拡張子] です。
Url
型
string
プロパティ
Create、Filter、Nillable、Group、Sort、Update
説明
(データベース内で保存する代わりに) ファイルを参照する URL。指定した場合、Body または BodyLength を指定しないでください。

使用方法

ドキュメントを作成または更新する場合、Body 項目または Url 項目のいずれかに値を指定できます。両方指定することはできません。

符号化されたデータ

API は、base64 データ型に符号化されたバイナリファイルデータを送受信します。レコード作成の前に、クライアントはバイナリファイルデータを base64 に符号化する必要があります。API レスポンスを受け取り次第、クライアントは、base64 データをバイナリ (この変換は通常 SOAP クライアントで処理します) に復号化する必要があります。

最大ドキュメントサイズ

作成または更新できるドキュメントは、最大 5 MB までです。