The Responsive application currently supports the following Content Library APIs:
Content Library APIs
Search Content Library Content by Applying Various Filters API |
|
API URL | /rfpserver/ext/v1/content-lib/search |
Description | Search Q&A pairs and documents by applying various filters. |
Type | POST |
Input |
Example: { "cursor": "*", "idsList": ["64ad80c579b41901a641aa2e"], "keyword": "*", "limit": 25, "metadata": true } |
Output | HistoricalContentLibrarySearchResponseList
|
ContentLibrarySearchVO
cursor |
string example: * Next pagination start record |
idsList |
string List of content ids to filter |
keyword |
string example: * Keyword in the content |
limit |
integer($int32) example: 25 No of limited records to be displayed in the result. Maximum limit:50. If the limit=0, then only the total number of records(just the count) matched will be returned in the response. |
metadata |
Boolean To get the complete details of the content, set the metadata as true |
HistoricalContentLibrarySearchResponseList
approversFacet |
[ List of Approvers by count ValueCountPair] |
businessUnitsFacets |
[ List of Business Units by count ValueCountPair] |
collectionFacets |
[ List of Collections by count ValueCountPair] |
customFieldFacets |
{ description: List of values by count for each custom field < * >: [ValueCountPair] } |
languageFacet |
[ List of Languages by count ValueCountPair] |
nextCursorMark |
string Cursor mark of last record fetched in the response |
ownerFacets |
[ List of Owners by count ValueCountPair] |
projectFacets |
[ List of Projects by count ValueCountPair] |
results | [HistoricalContentSearchResponseExtVO] |
sectionFacets |
[ List of Sections by count ValueCountPair] |
starRatingFacets |
[ List of Star Ratings by count ValueCountPair] |
tagFacets |
[ List of Tags by count ValueCountPair] |
totalRecords |
integer($int64) Total number of content records matched |
ValueCountPair
count | string |
value | string |
HistoricalContentSearchResponseExtVO
alReviewers |
[ List of Users who are assigned as Reviewers to the Content string] |
alertText |
string Alert Text |
alternateQuestions |
string Alternate Question |
answers |
[ Answer Text NameValuePair0] |
approvers |
[ List of Users who are assigned as Approvers/Moderators to the Content string] |
collectionList |
[ List of Collections string] |
companyId |
string Company Id |
contentScore |
integer($int32) Content Score |
contentType |
string Content Type Enum: [ ANSWER, DOCUMENT ] |
contentUrl |
string Redirect URL to access the Content Library content (except the content in the Trash) |
createdBy |
string User who created the content |
createdDate |
string($date-time) Created timestamp of Content |
customFields |
{ description: Custom Fields. Use custom field id as key and appropriate value. Use company entity-metadata API to get custom field Id. Value of custom field with type "TEXT BOX" should be "value1" and for types "DROPDOWN", "CHECKBOX", "RADIO", "SELECT USER", "MULTI SELECT DROPDOWN" value should be ["value1","value2",...] and for type DATE value should be {"from": "yyyy-mm-dd", "to": "yyyy-mm-dd"}. Custom field with type "TEXT AREA" is not searchable. Please refer to the custom fields in Organization settings for better clarity } |
customReviewCycleInDays |
integer($int32) Custom Review Cycle in Days, -1 value gets the default review cycle value |
deletedBy |
string User who deleted the content |
deletedDate |
string($date-time) Deleted timestamp of Content |
displayId |
string Display Id |
dueDate |
string Review dueDate. It should be a future date with format, yyyy-MM-dd |
editPrivacySetting |
[ List of Roles with edit privacy settings string] |
followUpDates |
[ Review Follow-Up Dates with format, yyyy-MM-dd string] |
hasImage |
boolean Indicates if Q&A Pair has Image in the Response |
hasOnDemandReview |
boolean Indicates if content is in On Demand Review |
hasRetainedCopy |
boolean Indicates if Q&A Pair in moderation has its original content retained |
id |
string Content Id |
importFileName |
string Imported File Name |
language |
string Language |
languageReviewers |
[ Language Reviewers of Translated Q&A Pair string] |
lastReviewedOn |
string Last Reviewed On Date |
lastUsedDate |
string($date-time) Last Used Date |
linkId |
string Link Id |
moderationContentId |
string Moderation Content Id |
numUsed |
integer($int32) Content Used Count |
onDemandReviewWorkflow |
string On Demand Review Workflow. Allowed Values are ["ANY", "ALL"] |
openCommentCount |
integer($int32) Open Comment Count of content |
owners |
[ List of Users who are assigned as Owners to the Content string] |
pendingId |
string Active Content Id in Library. Applicable if content is in moderation or review |
primaryBU |
string Business Unit Name associated |
privacySetting |
[ List of Roles with view privacy settings string] |
projectFiles |
[ List of files attached to Q&A Pair FileExtVO] |
projectId |
string Project Id. Applicable to Content added from Project |
projectName |
string Project Name |
question |
string Question Text |
relatedTo |
[ List of Q&A Pair Ids related to the content string] |
reviewFlag |
boolean Content Flag |
reviewId |
string Review Content Id |
reviewStatus |
boolean Content Review Status |
reviewWorkflow |
string Review Workflow. Allowed Values are ["ANY", "ALL"] |
reviewedList |
[ List of reviewers who have finished the review process string] |
sectionId |
string Section Id. Applicable to Content added from Project |
sectionName |
string Section Name |
source |
string Source of the Content |
standardResponse |
string Standard Response |
starRating |
integer($int32) Star Rating |
status |
string Content Status |
subscriptionByList |
[ List of subscribed users to the content string] |
tags |
[ List of Tags string] |
updateBy |
string User who updated the content |
updateDate |
string($date-time) Updated timestamp of Content |
NameValuePair0
key |
string example: Response Header Response Header |
value |
string example: Response Value Response Value |
FileExtVO
fileId |
string File Id |
fileName |
string File Name |
fileType |
string File Type |
size |
integer($int64) Document Size |
source |
string Document Source Enum: [ BOX, DOCUMENT_LIBRARY, DROPBOX, GOOGLE_DRIVE, HIGHSPOT, HUBSPOT, LOCAL_DRIVE, MICROSOFT_DYNAMICS_CRM, MICROSOFT_TEAMS, ONE_DRIVE, PARTNER_COMPANY, PIPEDRIVE, PIPELINE_DEALS, PREVIEW_RESPONSE, REQUEST_LIBRARY, SALESFORCE, SECTION_TEMPLATE, SEISMIC, SHAREPOINT, SLACK ] |
type |
string File Attachment type. Example: "ATTACHED" or "LINKED" Enum: [ ATTACHMENT, LINKED ] |
Upload Document |
||
API URL |
/rfpserver/ext/v1/content-lib/document/upload |
|
Description |
Upload a document, including any additional meta information | |
Type |
POST |
Request
ContentLibraryExtVO
alertText |
String Alert Text of the Document. |
customFields |
{String: Object} Custom field names and values to be searched can be passed as Map. |
tags |
Array[String] List of tags for the question. |
privacySetting |
String Set the privacy for viewing the Document by specifying the roles. Example: Admin with ALL Permissions, Manager, Team Member, Super Admin |
editPrivacySetting |
String Set the privacy for editing the Document by specifying the roles. Example: Admin with ALL Permissions, Manager, Team Member, Super Admin |
owners |
Array[String] List of user names |
approvers |
Array[String] List of user names |
starRating |
Integer Ratings that are allotted to Document |
collectionList |
Array[String] List of String containing Collection names |
dueDate |
String Due date for the Document review. |
customReviewCycleInDays | Integer Indicates the custom review cycle in days |
reviewFlag | Boolean Enable / Disable flag (default follow-up flag) for Document |
primaryBU^ |
String Primary Business Unit of the document. |
sharedBUs^ |
Array[String] Shared Business Unit of the document. |
enableReview | Boolean Need to enable review for the Document |
fileData* |
FileDataVO Details of the file |
FileDataVO
fileName* |
String Name of the file with extension. [ex: .docx, .pptx, .xlsx, .pdf, .txt]. The files with #Rejected extensions will not be accepted. The fileName and extension should always match the encoded data. |
description |
String Description of the file |
data* |
String Base64 encoded data |
* Mandatory Fields
^ Applicable only if BU is enabled for the instance.
# Rejected Extensions - [.ade, .adp, .apk, .appx, .appxbundle, .bat, .cab, .chm, .cmd, .com, .cpl, .dll, .dmg, .exe, .hta, .ins, .isp, .iso, .jar, .js, .jse, .lib, .lnk, .mde, .msc, .msi, .msix, .msixbundle, .msp, .mst, .nsh, .pif, .ps1, .scr, .sct, .shb, .sys, .vb, .vbe, .vbs, .vxd, .wsc, .wsf, .wsh, .xps]
Response
HistoricalSearchResponseVO
id |
String Id of the Document |
companyId |
String Id of the company |
createdDate |
Date Created date of the Document |
documentName |
String Name of the Document |
srcName |
String Name of the source |
fileId |
String Generated Id of the file |
fileType |
String Type of the file [Ex: application/pdf] |
size |
Integer Size of the Document |
description |
String Description of the document |
docVersion |
Integer Version of the Document |
downloadedCount |
Integer Number of times the file was downloaded |
customFields |
Map<String,Object> Use custom Fields internal name as key and appropriate value. Custom fields that are marked as required are mandatory. Please refer to the list of custom fields in the Organization settings for better clarity.You can get the list of custom fields from the get metadata list API with filter fieldType=CUSTOM |
businessUnits^ |
Array[String] List of all Business Units. |
primaryBU^ |
String Primary Business Unit of the document. |
sharedBUs^ |
Array[String] Shared Business Units of the document. |
alertText |
String Alert Text of the Document |
contentScore |
Integer Content score of Document |
updateDate |
Date Updated time of the Document. |
updateBy |
String User who has updated the Document |
alternateQuestions |
String Alternate Question Text of Document |
tags |
Array[String] List of tags for the question |
score |
Integer Score of the Document |
status |
String Status of the Document |
privacySetting |
Array[String] List of Role Id’s. Privacy for viewing the Document |
editPrivacySetting |
Array[String] List of Role Id’s. Privacy for editing the Document |
owners |
Array[String] List of user names |
approvers |
Array[String] List of user names |
dueDate |
String Due date of the Document |
followUpDates |
Array[String] Followup dates of the Document |
customReviewCycleInDays |
Integer Custom Review Cycle in days, if review is enabled |
numUsed |
Integer Total count of Document used |
language |
String Language of the Document |
reviewed |
Boolean Is Document is reviewed, if review is enabled |
needReview |
Boolean Need review for Document, if review is enabled |
starRating |
Integer Ratings that are allotted to the contents in CCL |
reviewFlag |
Boolean Need review flag to Document, if review is enabled |
reviewStatus |
Boolean Need review status to Document, if review is enabled |
enableReview |
Boolean Enable / Disable review for Document |
collectionList |
Array[String] List of String containing Collection Ids |
hasImage |
Boolean Is Document has image as response |
reviewWorkflow |
String Workflow type of the Document’s review process |
hasOnDemandReview |
Boolean Need onDemandReview for Document |
hasLinkedDoc |
Boolean Is any linked documents to Document |
editedInReview |
Boolean Is Document edited on review |
collectionNames |
Array[String] List of String containing Collection Names |
source |
String Source of Document [LOCAL_DRIVE] |
contentType |
String Type of content added [DOCUMENT] |
^ Applicable only if BU is enabled for the instance.
Example:
RequestURL:
https://dev1.rfpio.com/rfpserver/rfpserver/ext/v1/content-lib/document/upload
Response:
{ |
Response:
{ |
Upload New Version of Document |
||
API URL |
/rfpserver/ext/v1/content-lib/document/{documentId}/upload-new-version |
|
Description |
Upload a new version of the document present in the Content Library with documentId. | |
Type |
POST |
Request
Map<String, Object>
data* |
String Base64 encoded data of the new version of file |
fileName* |
String Name of the file with extension. [ex: .docx, .pptx, .xlsx, .pdf, .txt]. The files with #Rejected Extensions will not be accepted. The fileName and extension should always match the data given. |
* Mandatory Fields
# Rejected Extensions - [.ade, .adp, .apk, .appx, .appxbundle, .bat, .cab, .chm, .cmd, .com, .cpl, .dll, .dmg, .exe, .hta, .ins, .isp, .iso, .jar, .js, .jse, .lib, .lnk, .mde, .msc, .msi, .msix, .msixbundle, .msp, .mst, .nsh, .pif, .ps1, .scr, .sct, .shb, .sys, .vb, .vbe, .vbs, .vxd, .wsc, .wsf, .wsh, .xps]
Response
HistoricalSearchResponseVO
id |
String Id of the Document |
companyId |
String Id of the company |
createdDate |
Date Created date of the Document |
documentName |
String Name of the Document |
srcName |
String Name of the source |
fileId |
String Generated Id of the file |
fileType |
String Type of the file [Ex: application/pdf] |
size |
Integer Size of the Document |
description |
String Description of the document |
docVersion |
Integer Version of the Document |
downloadedCount |
Integer Number of times the file was downloaded |
customFields |
Map<String,Object> Use custom Fields internal name as key and appropriate value. Custom fields that are marked as required are mandatory. Please refer to the list of custom fields in the Organization settings for better clarity.You can get the list of custom fields from the get metadata list API with filter fieldType=CUSTOM |
businessUnits^ |
Array[String] List of Business Units of the Document. |
primaryBU^ |
String Primary Business Unit of the Document. |
sharedBUs^ |
Array[String] List of shared Business Units of the Document. |
alertText |
String Alert Text of the Document |
contentScore |
Integer Content score of Document |
updateDate |
Date Updated time of the Document. |
updateBy |
String User who updated the Document |
alternateQuestions |
String Alternate Question Text of Document |
tags |
Array[String] List of tags for the question |
score |
Integer Score of the Document |
status |
String Status of the Document |
privacySetting |
Array[String] List of Role Id’s. Privacy for viewing the Document |
editPrivacySetting |
Array[String] List of Role Id’s. Privacy for editing the Document |
owners |
Array[String] List of user names |
approvers |
Array[String] List of user names |
dueDate |
String Due date of the Document |
followUpDates |
Array[String] Followup dates of the Document |
customReviewCycleInDays |
Integer Custom Review Cycle in days, if review is enabled |
numUsed |
Integer Total count of Document used |
language |
String Language of the Document |
reviewed |
Boolean Is Document is reviewed, if review is enabled |
needReview |
Boolean Need review for Document, if review is enabled |
starRating |
Integer Ratings that are allotted to the contents in AL |
reviewFlag |
Boolean Need review flag to Document, if review is enabled |
reviewStatus |
Boolean Need review status to Document, if review is enabled |
enableReview |
Boolean Enable / Disable review for Document |
collectionList |
Array[String] List of String containing Collection Ids |
hasImage |
Boolean Is Document has image as response |
reviewWorkflow |
String Workflow type of the Document’s review process |
hasOnDemandReview |
Boolean Need onDemandReview for Document |
hasLinkedDoc |
Boolean Is any linked documents to Document |
editedInReview |
Boolean Is Document edited on review |
collectionNames |
Array[String] List of String containing Collection Names |
source |
String Source of Document [LOCAL_DRIVE] |
contentType |
String Type of content added [DOCUMENT] |
^ Applicable only if BU is enabled for the instance.
Example:
RequestURL:
https://dev1.rfpio.com/rfpserver/rfpserver/ext/v1/content-lib/document/{63f7b2a184e75d16a3dcfa0c}/upload-new-version
Request:
{ |
Response:
{ |
Create Tags |
|
API URL | /rfpserver/ext/v1/content-lib/tags/create |
Description | Add tags to the Organization Settings. |
Type | POST |
Input |
Sample: [ { "backgroundColor": "#23b7e5", "foregroundColor": "#fff", "primaryBU": "India", "tagName": "testTag" } ] |
The tag definition includes foreground and background colors, specified as hexadecimal numbers. The colors must begin with # and be either:
- A maximum of six characters consisting of the letters a-f or A-F, or digits 0-9
- A minimum of three characters consisting of the letters a-f or A-F, or digits 0-9
For example, #23b7e5 or #fff are valid hexadecimal codes. To see the codes that represent the colors, refer to https://htmlcolorcodes.com.
Request
List[TagCreateExtVO]
backgroundColor |
string example: #23b7e5 Background Color of the Tag |
foregroundColor |
string example: #fff Foreground Color of the Tag |
primaryBU |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
tagName* |
string example: testTag Tag Name |
Response
If the request is successful, 207 status is returned since it may have different status for each tag record.
Response schema:
[
{
"reason": <string>,
"message": <string>,
"tagVO": TagExtVO,
"status": integer
}
]
TagExtVO
backgroundColor |
string example: #23b7e5 Background Color of the Tag |
companyId |
string Company Id |
createdBy |
string User who created the tag |
createdDate |
string($date-time) Created timestamp of tag |
foregroundColor |
string example: #fff Foreground Color of the Tag |
id |
string Tag Id |
primaryBU |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
tagName* |
string example: testTag Tag Name |
updatedBy |
string User who updated the tag |
updatedDate |
string($date-time) Updated timestamp of tag |
Example
https://dev1.rfpio.com/rfpserver/ext/v1/content-lib/tags/create
Request
[
{
"tagName": "Testing in Progress",
"primaryBU":"India",
"foregroundColor":"#fff",
"backgroundColor":"#800080"
},
{
"tagName":"product management",
"primaryBU":"Seoul",
"foregroundColor":"#fff",
"backgroundColor":"#FFA500"
}
]
Response:
{
"backgroundColor": "#23b7e5",
"companyId": "",
"createdBy": "",
"createdDate": "2023-08-16T12:19:56.846Z",
"foregroundColor": "#fff",
"id": "",
"primaryBU": "India",
"tagName": "testTag",
"updatedBy": "",
"updatedDate": "2023-08-16T12:19:56.846Z"
}
Update Tags |
|
API URL | /rfpserver/ext/v1/content-lib/tags/update |
Description | Update existing tags in the Organization Settings. |
Type | POST |
Input |
List[TagUpdateExtVO] Example: [ { "backgroundColor": "", "foregroundColor": "", "id": "", "primaryBU": "India", "tagName": "testTag" } ] |
The tag definition includes foreground and background colors, specified as hexadecimal numbers. The colors must begin with # and be either:
- A maximum of six characters consisting of the letters a-f or A-F, or digits 0-9
- A minimum of three characters consisting of the letters a-f or A-F, or digits 0-9
For example, #23b7e5 or #fff are valid hexadecimal codes. To see the codes that represent the colors, refer to https://htmlcolorcodes.com.
Request
List[TagUpdateExtVO]
backgroundColor |
string Background Color of the Tag. example : #23b7e5 |
foregroundColor |
string Foreground Color of the Tag. example : #fff |
id* |
string Tag Id |
primaryBU |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
tagName* |
string example: testTag Tag Name |
Response
If the request is successful, 207 status is returned since it may have different status for each tag record.
Response schema:
[
{
"message": <string>,
"tagVO": TagExtVO,
"status": integer
}
]
TagExtVO
backgroundColor |
string example: #23b7e5 Background Color of the Tag |
companyId |
string Company Id |
createdBy |
string User who created the tag |
createdDate |
string($date-time) Created timestamp of tag |
foregroundColor |
string example: #fff Foreground Color of the Tag |
id |
string Tag Id |
primaryBU |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
tagName* |
string example: testTag Tag Name |
updatedBy |
string User who updated the tag |
updatedDate |
string($date-time) Updated timestamp of tag |
Example
{
"backgroundColor": "#23b7e5",
"companyId": "",
"createdBy": "",
"createdDate": "2023-08-17T04:44:57.311Z",
"foregroundColor": "#fff",
"id": "",
"primaryBU": "India",
"tagName": "testTag",
"updatedBy": "",
"updatedDate": "2023-08-21 22:13:04 -07:0"
}
List Tags |
|
API URL | /rfpserver/ext/v1/content-lib/tags/list |
Description | Gets a list of the tags by applying various filters |
Type | POST |
Input |
Example: { "limit": 100, "offset": 0, "primaryBU": [], "searchTerm": "" } |
The tag definition includes foreground and background colors, specified as hexadecimal numbers. The colors must begin with # and be either:
- A maximum of six characters consisting of the letters a-f or A-F, or digits 0-9
- A minimum of three characters consisting of the letters a-f or A-F, or digits 0-9
For example, #23b7e5 or #fff are valid hexadecimal codes. To see the codes that represent the colors, refer to https://htmlcolorcodes.com.
Request
TagFilterExtRequestVO
limit |
integer($int32) example: 100 Number of records to be fetched. Maximum limit:100. If limit=-1, then only total number of records(just the count) matched will be returned |
offset |
integer($int32) example: 0 Fetch records starting from the specified value. Offset is used for pagination |
primaryBU |
[ List of primary business units string] |
searchTerm |
string Tag name |
Response
If the request is successful, 200 status is returned along with the list of tags.
TagResponseListExtVO
tagList | [TagExtVO] |
totalRecords |
integer($int64) Total number of tag records matched |
TagExtVO
backgroundColor |
string example: #23b7e5 Background Color of the Tag |
companyId |
string Company Id |
createdBy |
string User who created the tag |
createdDate |
string($date-time) Created timestamp of tag |
foregroundColor |
string example: #fff Foreground Color of the Tag |
id |
string Tag Id |
primaryBU |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
tagName* |
string example: testTag Tag Name |
updatedBy |
string User who updated the tag |
updatedDate |
string($date-time) Updated timestamp of tag |
Delete Tags |
|
API URL | /rfpserver/ext/v1/content-lib/tags/delete |
Description | Deletes tags from the Organization Settings |
Type | POST |
Request
DeleteRequestVO
idList |
List<String> |
Response
If the request is successful, 207 status is returned since it may have different status for each tag record.
Response schema:
[
{
"message": <string>,
"status": integer
"tags": List<string>
}
]
Content Usage Report |
||
API URL |
/rfpserver/ext/v1/reports/{content}-usage-report |
|
Description |
Retrieves the Content Usage report from the Content Library (Q&A pairs and Documents) by using various filters. | |
Type |
POST |
|
Input (Path param) |
content |
Content type needs to be passed either answer or document. |
Request Body:
ContentUsageReportRequestVO
performedBy |
Array[string] Optional List of users email addresses |
operationUsed |
Array[string] Optional List of operations in the content library. Accepted values - [ADD, LOOKUP_MS_ADDIN_COPY, AUTO_RESPOND, DOWNLOAD, CONTENT_ATTACH, OVERRIDE, CONTENT_ATTACH_LINK, COPY, INDIRECT_ATTACH, EMBED, MS_ADDIN_DOWNLOAD, DIRECT_ATTACH, MS_ADDIN_APPLY, LOOKUP_MS_ADDIN_APPLY, APPLY, MS_ADDING_COPY, LOOKUP_COPY] |
fromDate |
date-time Optional Date from which the results to be filtered |
toDate |
date-time Optional Date to which the results to be filtered |
limit |
Integer Optional No. of limited records to be displayed in the result. Minimum limit:1, Maximum limit:100. |
Offset |
String Optional Offset Value from which next set of results is fetched |
Response:
ContentUsageReportResponseVO
id |
String Optional Id of the entry created in content library |
companyId |
String Optional Id of the company |
operationUsed |
String Optional Operation used in content library. This could carry one of these values [ADD, LOOKUP_MS_ADDIN_COPY, AUTO_RESPOND, DOWNLOAD, CONTENT_ATTACH, OVERRIDE, CONTENT_ATTACH_LINK, COPY, INDIRECT_ATTACH, EMBED, MS_ADDIN_DOWNLOAD, DIRECT_ATTACH, MS_ADDIN_APPLY, LOOKUP_MS_ADDIN_APPLY, APPLY, MS_ADDING_COPY, LOOKUP_COPY] |
contentId |
String Optional Id of the content |
contentLibraryQuestion |
String Optional Question present in content library |
usedEntity |
String Optional Used entity in content library |
entityId |
String Optional Id of the entity |
entityName |
String Optional Name of the entity |
usedQuestion |
String Optional Question used in content library |
fileName |
String Optional Name of the file |
version |
integer Optional Version number of the file |
performedBy |
String Optional Email address of the user |
createdDate |
date-time Optional Entry created date |
Note #1
The below tabulations are the list of keywords used in the operationUsed field and its corresponding operations-
Operation Used in Answer Library
Keyword in API |
Corresponding Operations in UI |
OVERRIDE |
Override |
COPY |
Copy |
APPLY |
Apply |
LOOKUP_MS_ADDIN_APPLY |
LookUp for MS Office Apply |
AUTO_RESPOND |
Auto Respond |
OperationUsed in Document Library
Keyword in API |
Corresponding Operations in UI |
CONTENT_ATTACH_LINK |
Content Attachment (Link) |
CONTENT_ATTACH |
Content Attachment |
DOWNLOAD |
Download |
DIRECT_ATTACH |
Direct Attach |
AUTO_RESPOND |
Auto Respond |
INDIRECT_ATTACH |
Indirect Attach |
MS_ADDIN_APPLY |
LookUp for MS Office Apply |
MS_ADDING_COPY |
MS Companion Copy |
MS_ADDIN_DOWNLOAD |
MS LookUp Download |
EMBED |
Embed |
Note #2
The responses, populated as part of this API are with respect to the collections associated with the user who generates the “RFPIO API Token”.
Example 1:
Request: https://dev1.rfpio.com/rfpserver/ext/v1/reports/answer-usage-report
{ "performedBy": ["user@company.com"], "operationUsed": ["COPY"], "fromDate":"2020-10-26 09:57:02 +05:30", "toDate":"2022-10-26 09:58:02 +05:30", "limit": 2, "offset": 0 } |
Response:
[ { "id": "6358b7167e0f7a954fd2683d", "companyId": "633ab6d732876b47a2196e96", "operationUsed": "COPY", "contentId": "63464d53c30db672ad1fd747", "contentLibraryQuestion": "Please feed the quantity required", "usedEntity": "PROJECT", "entityId": "6345158f2eb0fe7cbdc7461e", "entityName": "TestEntity", "usedQuestion": "", "version": 0, "performedBy": "user@company.com", "createdDate": "2022-10-26 09:57:02 +05:30" }, { "id": "6358b6a27e0f7a954fd267db", "companyId": "633ab6d732876b47a2196e96", "operationUsed": "COPY", "contentId": "63464dc7c30db672ad1fd74e", "contentLibraryQuestion": "What is the processor name?", "usedEntity": "PROJECT", "entityId": "6345158f2eb0fe7cbdc7461e", "entityName": "TestEntity", "usedQuestion": "", "version": 0, "performedBy": "user@company.com", "createdDate": "2022-10-26 09:55:06 +05:30" } ] |
Example 2
Request: https://dev1.rfpio.com/rfpserver/ext/v1/reports/answer-usage-report
{ "performedBy": ["user@company.com"], "operationUsed": ["DIRECT_ATTACH"], "fromDate":"2020-10-26 09:57:02 +05:30", "toDate":"2022-10-26 09:58:02 +05:30", "limit": 2, "offset": 0 } |
Response:
[ { "id": "63469ce302e0293420d09de9", "companyId": "633ab6d732876b47a2196e96", "operationUsed": "DIRECT_ATTACH", "contentId": "63464f92c30db672ad1fd76c", "usedEntity": "PROJECT_DOCUMENT", "entityId": "634517262eb0fe7cbdc7462b", "fileName": "Sample RFP.docx", "version": 1, "performedBy": "user@company.com", "createdDate": "2022-10-12 16:24:27 +05:30" }, { "id": "6346500dc30db672ad1fd787", "companyId": "633ab6d732876b47a2196e96", "operationUsed": "DIRECT_ATTACH", "contentId": "63464f92c30db672ad1fd76c", "usedEntity": "PROJECT_DOCUMENT", "entityId": "634530ca2eb0fe7cbdc74670", "fileName": "Sample RFP.docx", "version": 1, "performedBy": "user@company.com", "createdDate": "2022-10-12 10:56:37 +05:30" } ] |
Increase Used Count |
||
API URL |
/rfpserver/ext/v1/content-lib/increment-used-count/{contentId} |
|
Description |
Increases the used count the contents that are accessed via external APIs | |
Type |
POST |
|
Input (Path param) |
contentId |
id of the content to increase the used count of value. |
Request Body:
BaseContentUsageReportResponseVO
companyId |
string Company Id |
contentId |
string Content Id |
contentLibraryQuestion |
string Question Text. Applicable if content type is Answer |
createdDate |
string($date-time) Created timestamp of content |
fileName |
string File name along with extension. Applicable if content type is Document |
operationUsed |
string Operation used to increment the count of the content |
performedBy |
string User who performed the operation |
version |
integer($int32) Document Version |
Response Body Example
{
"companyId": "",
"contentId": "",
"contentLibraryQuestion": "",
"createdDate": "2023-08-16T11:08:22.383Z",
"fileName": "",
"operationUsed": "",
"performedBy": "",
"version": 0
}
Example
https://dev1.rfpio.com/rfpserver/ext/v1/content-lib/increment-used-count/649aeacfe59ba576515d8f77
Response
{
"companyId": "6476dfd3677be5137922fb98",
"contentId": "649aeacfe59ba576515d8f77",
"contentLibraryQuestion": "Question created from External API AL ",
"createdDate": "2023-08-18 05:36:07 -07:00",
"operationUsed": "OTHERS",
"performedBy": "test@client.com",
"version": 0
}
Delete Content |
||
API URL |
/rfpserver/ext/v1/content-lib/delete |
|
Description |
Delete content in the content library; use content library search to get idList of content. | |
Type |
POST |
|
Request Body |
{ "idList": [ "65cda4e6dcc3ea5c72f5d625", "65cda505dcc3ea5c72f5d660", "65b7373b184a1858f519a855" ], "isMoveToTrash": false } |
ContentLibraryDeleteRequestVO idList (string, mandatory): List of content IDs for which the content has to be deleted. Use ContentLibrary Search API to get idList of content. Maximum limit:50
isMovetoTrash (Boolean, Optional): If value is set as True, content will be moved to trash and it can be recovered later, if needed. If value is set as False, content will be deleted permanently. By default, the value is False. |
Output |
If the delete operation is successful, the response would be the “DELETED_RECORDS” or “NON_DELETED_RECORDS” with the status code 207. Example: [ { "DELETED_RECORDS": [ "65cda505dcc3ea5c72f5d660", "65cda4e6dcc3ea5c72f5d625" ], "status": 200 }, { "NON_DELETED_RECORDS": [ "65b7373b184a1858f519a855" ], "status": 400 } ] |
Note: The API endpoints either start with /rfpserver. The baseUrl for most customers is app.rfpio.com. For more details, please reach out to your CSM or contact accountmanagers@responsive.io. |
For details on other endpoints, click here.