For a list of operations associated with this REST API service, see the following table.
| Name | Description |
|---|---|
InsertOrUpdate |
Creates literature or update existing literature. |
Update |
Updates an existing literature. |
Insert |
Creates literature. |
|
Delete |
Deletes literature. |
QueryById |
Queries for literature using Row ID. |
|
QueryByExample |
Queries for literature using the QueryPage method. |
Message Description: Literature Web Service - InsertOrUpdate
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management). |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
|
Description |
Enter a description of the document. Because literature items can be in any language, you may want to indicate the language of the item in this field (or in the Name field). |
String |
|
Sales Tool Type |
Select the type of the literature. You can create new literature types in the List of Values Administration view. The Literature Type field is used to filter literature items in various applets. |
String |
|
LitFileSize |
The size of the literature file. |
String |
|
LitFileExt |
The file extension of the literature file, for example, .doc or .pdf. |
String |
|
LitFileDate |
The date when the literature file was modified. |
String |
|
LitFileName |
Literature file name. |
String |
|
LitFileSrcType |
Source of the Literature records, for example, a file or URL. |
String |
|
LitFileSrcPath |
Source path of the literature record. |
String |
|
Abstract |
Optionally, enter a synopsis of the document's content. |
String |
|
Primary Organization Name |
Name of the primary organization of literature record. |
String |
|
Author |
Name of the document's author. |
String |
|
ListOfAdmin Sales Tool_Internal Product |
Select any products associated with the literature. Use this section to allow the user to display the literature under a product. |
Integration Component |
|
ListOfAdmin Sales Tool_Organization |
Select organizations that will have visibility to this data. |
Integration Component |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management). |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
|
Description |
Enter a description of the document. Because literature items can be in any language, you may want to indicate the language of the item in this field (or in the Name field). |
String |
|
Sales Tool Type |
Select the type of the literature. You can create new literature types in the List of Values Administration view. The Literature Type field is used to filter literature items in various applets. |
String |
|
LitFileSize |
The size of the literature file. |
String |
|
LitFileExt |
The file extension of the literature file, for example, .doc or .pdf. |
String |
|
LitFileDate |
The date when the literature file was modified. |
String |
|
LitFileName |
Literature file name. |
String |
|
LitFileSrcType |
Source of the Literature records, for example, a file or URL. |
String |
|
LitFileSrcPath |
Source path of the literature record. |
String |
|
Abstract |
Optionally, enter a synopsis of the document's content. |
String |
|
Primary Organization Name |
Name of the primary organization of literature record. |
String |
|
Author |
Name of the document's author. |
String |
|
ListOfAdmin Sales Tool_Internal Product |
Select any products associated with the literature. Use this section to allow the user to display the literature under a product. |
Integration Component |
|
ListOfAdmin Sales Tool_Organization |
Select organizations that will have visibility to this data. |
Integration Component |
Message Description: Literature Web Service - Update
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management) |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
|
Description |
Enter a description of the document. Because literature items can be in any language, you may want to indicate the language of the item in this field (or in the Name field). |
String |
|
Sales Tool Type |
Select the type of the literature. You can create new literature types in the List of Values Administration view. The Literature Type field is used to filter literature items in various applets. |
String |
|
LitFileSize |
The size of the literature file. |
String |
|
LitFileExt |
The file extension of the literature file, for example, .doc or .pdf. |
String |
|
LitFileDate |
The date when the literature file was modified. |
String |
|
LitFileName |
Literature file name. |
String |
|
LitFileSrcType |
Source of the Literature records, for example, a file or URL. |
String |
|
LitFileSrcPath |
Source path of the literature record. |
String |
|
Abstract |
Optionally, enter a synopsis of the document's content. |
String |
|
Primary Organization Name |
Name of the primary organization of literature record. |
String |
|
Author |
Name of the document's author. |
String |
|
ListOfAdmin Sales Tool_Internal Product |
Select any products associated with the literature. Use this section to allow the user to display the literature under a product. |
Integration Component |
|
ListOfAdmin Sales Tool_Organization |
Select organizations that will have visibility to this data. |
Integration Component |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management). |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
|
Description |
Enter a description of the document. Because literature items can be in any language, you may want to indicate the language of the item in this field (or in the Name field). |
String |
|
Sales Tool Type |
Select the type of the literature. You can create new literature types in the List of Values Administration view. The Literature Type field is used to filter literature items in various applets. |
String |
|
LitFileSize |
The size of the literature file. |
String |
|
LitFileExt |
The file extension of the literature file, for example, .doc or .pdf. |
String |
|
LitFileDate |
The date when the literature file was modified. |
String |
|
LitFileName |
Literature file name. |
String |
|
LitFileSrcType |
Source of the Literature records, for example, a file or URL. |
String |
|
LitFileSrcPath |
Source path of the literature record. |
String |
|
Abstract |
Optionally, enter a synopsis of the document's content. |
String |
|
Primary Organization Name |
Name of the primary organization of literature record. |
String |
|
Author |
Name of the document's author. |
String |
|
ListOfAdmin Sales Tool_Internal Product |
Select any products associated with the literature. Use this section to allow the user to display the literature under a product. |
Integration Component |
|
ListOfAdmin Sales Tool_Organization |
Select organizations that will have visibility to this data. |
Integration Component |
Message Description: Literature Web Service - Insert
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management). |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
|
Description |
Enter a description of the document. Because literature items can be in any language, you may want to indicate the language of the item in this field (or in the Name field). |
String |
|
Sales Tool Type |
Select the type of the literature. You can create new literature types in the List of Values Administration view. The Literature Type field is used to filter literature items in various applets. |
String |
|
LitFileSize |
The size of the literature file. |
String |
|
LitFileExt |
The file extension of the literature file, for example, .doc or .pdf. |
String |
|
LitFileDate |
The date at which the literature file was modified. |
String |
|
LitFileName |
Literature file name. |
String |
|
LitFileSrcType |
Source of the Literature records, for example, a file or URL. |
String |
|
LitFileSrcPath |
Source path of the literature record. |
String |
|
Abstract |
Optionally, enter a synopsis of the document's content. |
String |
|
Primary Organization Name |
Name of the primary organization of literature record. |
String |
|
Author |
Name of the document's author |
String |
|
ListOfAdmin Sales Tool_Internal Product |
Select any products associated with the literature. Use this section to allow the user to display the literature under a product. |
Integration Component |
|
ListOfAdmin Sales Tool_Organization |
Select organizations that will have visibility to this data. |
Integration Component |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management). |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
|
Description |
Enter a description of the document. Because literature items can be in any language, you may want to indicate the language of the item in this field (or in the Name field). |
String |
|
Sales Tool Type |
Select the type of the literature. You can create new literature types in the List of Values Administration view. The Literature Type field is used to filter literature items in various applets. |
String |
|
LitFileSize |
The size of the literature file. |
String |
|
LitFileExt |
The file extension of the literature file, for example, .doc or .pdf. |
String |
|
LitFileDate |
The date when the literature file was modified. |
String |
|
LitFileName |
Literature file name. |
String |
|
LitFileSrcType |
Source of the Literature records, for example, a file or URL. |
String |
|
LitFileSrcPath |
Source path of the literature record. |
String |
|
Abstract |
Optionally, enter a synopsis of the document's content. |
String |
|
Primary Organization Name |
Name of the primary organization of literature record. |
String |
|
Author |
Name of the document's author. |
String |
|
ListOfAdmin Sales Tool_Internal Product |
Select any products associated with the literature. Use this section to allow the user to display the literature under a product. |
Integration Component |
|
ListOfAdmin Sales Tool_Organization |
Select organizations that will have visibility to this data. |
Integration Component |
Message Description: Literature Web Service - Delete
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management). |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management). |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
Message Description: Literature Web Service – QueryById
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
PrimaryRowId |
The row ID of the literature. |
String |
|
OutputIntObjectName |
Name of the output integration object. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management). |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
|
Description |
Enter a description of the document. Because literature items can be in any language, you may want to indicate the language of the item in this field (or in the Name field). |
String |
|
Sales Tool Type |
Select the type of the literature. You can create new literature types in the List of Values Administration view. The Literature Type field is used to filter literature items in various applets. |
String |
|
LitFileSize |
The size of the literature file. |
String |
|
LitFileExt |
The file extension of the literature file, for example, .doc or .pdf. |
String |
|
LitFileDate |
The date when the literature file was modified. |
String |
|
LitFileName |
Literature file name. |
String |
|
LitFileSrcType |
Source of the Literature records, for example, a file or URL. |
String |
|
LitFileSrcPath |
Source path of the literature record. |
String |
|
Abstract |
Optionally, enter a synopsis of the document's content. |
String |
|
Primary Organization Name |
Name of the primary organization of literature record. |
String |
|
Author |
Name of the document's author. |
String |
|
ListOfAdmin Sales Tool_Internal Product |
Select any products associated with the literature. Use this section to allow the user to display the literature under a product. |
Integration Component |
|
ListOfAdmin Sales Tool_Organization |
Select organizations that will have visibility to this data. |
Integration Component |
Message Description: Literature Web Service – QueryByExample
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management) |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdmin Sales Tool (Content Management) |
An instance of the integration object Admin Sales Tool (Content Management). |
Integration Object |
|
Admin Sales Tool |
An integration component (XML tag) corresponding to the Admin Sales Tool business component. You can create multiple instances of Admin Sales Tool under ListOfAdmin Sales Tool (Content Management). |
Integration Component |
|
Name |
Name of the literature record. |
String |
|
Description |
Enter a description of the document. Because literature items can be in any language, you may want to indicate the language of the item in this field (or in the Name field). |
String |
|
Sales Tool Type |
Select the type of the literature. You can create new literature types in the List of Values Administration view. The Literature Type field is used to filter literature items in various applets. |
String |
|
LitFileSize |
The size of the literature file. |
String |
|
LitFileExt |
The file extension of the literature file, for example, .doc or .pdf. |
String |
|
LitFileDate |
The date when the literature file was modified. |
String |
|
LitFileName |
Literature file name. |
String |
|
LitFileSrcType |
Source of the Literature records, for example, a file or URL. |
String |
|
LitFileSrcPath |
Source path of the literature record. |
String |
|
Abstract |
Optionally, enter a synopsis of the document's content. |
String |
|
Primary Organization Name |
Name of the primary organization of literature record. |
String |
|
Author |
Name of the document's author. |
String |
|
ListOfAdmin Sales Tool_Internal Product |
Select any products associated with the literature. Use this section to allow the user to display the literature under a product. |
Integration Component |
|
ListOfAdmin Sales Tool_Organization |
Select organizations that will have visibility to this data. |
Integration Component |