Lightbox文書: 必須属性およびパス・パラメータ
この項では、Lightbox Documentsリソースとその子リソースのリクエスト・ペイロードの必須属性およびパス・パラメータを示します。
次の表に、親リソースとその子リソースの関係を示します。
| 親レベル |
Lightbox文書 |
| 子リソース |
Document-viewed-outside-Lightboxシグナル |
| Page-viewed-outside-Lightboxシグナル |
|
| 共有個人インスタンス |
次の表に、Lightbox DocumentsリソースのPOSTメソッドに必要な属性を示します。
| リソース | 属性 | 属性の説明 |
|---|---|---|
| Lightbox文書 |
FileName |
ドキュメントのファイル名。 |
次の表に、Lightbox Documents子リソースのPOSTメソッドに必要な属性を示します。
| リソース | 属性 | 属性の説明 |
|---|---|---|
| Lightbox文書 > Document-Viewed-Outside-Lightboxシグナル |
LightboxDocumentId |
Lightbox文書の一意の識別子。 |
| Lightboxドキュメント > Lightboxドキュメント・ページ > Page-viewed-outside-Lightboxシグナル |
LightboxDocumentId |
Lightbox文書の一意の識別子。 |
| Lightbox文書>共有個人インスタンス |
SharedUserPartyId |
文書が共有されたパーティの一意の識別子。 |
次の表に、Lightbox DocumentsリソースのPATCHメソッドに必要なパス・パラメータを示します。
| リソース | パス | パス・パラメータ |
|---|---|---|
| Lightbox文書 |
/crmRestApi/resources/11.13.18.10/lightboxDocuments/{LightboxDocumentId} |
LightboxDocumentId |
次の表に、Lightbox Documents子リソースのPATCHメソッドに必要なパス・パラメータを示します。
| リソース | パス | パス・パラメータ |
|---|---|---|
| Lightbox文書>共有個人インスタンス |
/crmRestApi/resources/11.13.18.10/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId} |
LightboxDocumentId LightboxDocumentPageId |