| DOCUMENT_SEARCH | DOCUMENT Endpoint | |
| /rpc/document/?method=DOCUMENT_SEARCH | ||
| For information on how to use Advanced Searches, click here |
| DETAILS | |||
| Prefix | Document |
| SUB SEARCHES | |||
| Attachment | CORE_ATTACHMENT_SEARCH | This returns all attachments linked to the product | |
| DocumentFolderLink | DOCUMENT_FOLDER_LINK_SEARCH |
| CUSTOM OPTIONS | TYPE | ||
| IncludeMyNetworkGroups | Text | Y / N [default]. Allows you to include documents from other spaces shared via NetWork Groups, and can also limit what documents you see in your own space | |
| IncludeMyDocuments | Text | Y / N [default]. If searching based on Network Groups (ie IncludeMyNetworkGroups = Y), should it also include documents in your space. | |
| ExcludeNetworkGroup | Text | Comma delimited list of Network Groups to exclude |
| AVAILABLE FIELDS | TYPE | ||
| AllowInFrames | Text (1) | Y/N | |
| Content | Text (Huge) | ||
| HeadDocument | Numeric | If a document is being rendered as a website, you can override the default HEAD ... /HEAD section by pointing to another document which contains it | |
| HeadDocumentText | Text (50) | ||
| Id | Numeric | ||
| IgnoreWebsiteHeaderTags | Text (1) | Y/N | |
| IgnoreWebsiteLayout | Text (1) | Y/N | |
| InternalReference | Numeric | ||
| Keywords | Text (200) | ||
| LayoutDocument | Numeric | For backwards compatibility with the classic system | |
| LayoutDocumentText | Text (200) | ||
| Notes | Text (2000) | ||
| Object | Numeric | ||
| ObjectText | Text (50) | ||
| Private | Text (1) | Y / N [default]. If 'Y', only the creator of the document can see | |
| Public | Text (1) | Y / N [default]. If 'Y', then the document can be seen via SITE_DOCUMENT_SEARCH | |
| Status | Numeric | 1=Draft,2=Approved,3=Under Review,4=To Be Linked To Folders | |
| StatusText | Text (50) | ||
| Summary | Text (2000) | ||
| Template | Text (1) | Y/N | |
| Title | Text (200) | ||
| Type | Numeric | 5=[Standard],6=Text Document,7=Attachments Only (File Folder),8=Help Text,9=System Template | |
| TypeText | Text (50) | ||
| URL | Text (500) |
| TEMPLATE FIELDS | TYPE | You should only need these fields if dealing with legacy systems | |
| DefaultDocumentForObject | Text (1) | Y/N | |
| IncludeReferenceInTitle | Text (1) | Y/N | |
| MaximumColumnsPerPage | Numeric | ||
| MaximumRowsPerPage | Numeric | ||
| Object | Numeric | ||
| ObjectText | Text | ||
| SubLinkType | Numeric | ||
| SubLinkTypeText | Text |
| RETURN | ||
| Selected Fields |
| EXAMPLE | |
| 1. Return all documents, with all the folders that they are in. Return the results in JSON format | |
{
"fields":
[
{
"name": "document.title"
},
{
"name": "document.documentfolderlink.folder.title"
}
],
"options":
{
"rf": "JSON"
}
}
|