The Responsive application currently supports the following Answer Library APIs:
Answer Library APIs
Answer Library Search |
||
|
API URL |
/rfpserver/ext/v1/answer-lib/search |
|
|
Description |
Search answer library content applying various filters. |
|
|
Type |
POST |
|
|
Input |
{ "cursor": "*", "idsList": ["64ad80c579b41901a641aa2e"], "keyword": "*", "limit": 25, "metadata": true } |
AnswerLibrarySearchVO |
| Output |
JSON object containing the searched items. |
|
Answer Library Add |
||
|
API URL |
/rfpserver/ext/v1/answer-lib/add |
|
|
Description |
Adds new content to the Answer Library. For authorization, use user’s API token. |
|
|
Type |
POST |
|
|
Input |
{ "alertText": "TestAlertText", "alternateQuestions": "Alternate question on details about your company", "answers": [ { "key": "Response Header", "value": "Response Value" } ], "approvers": [], "collectionList": [], "customFields": {}, "customReviewCycleInDays": 0, "dueDate": "", "editPrivacySetting": [], "enableReview": false, "followUpDates": [], "language": "", "owners": [], "primaryBU": "India", "privacySetting": [], "projectName": "TestProjectName", "question": "Brief details about your company", "reviewFlag": false, "reviewWorkflow": "", "sectionName": "TestSection", "standardResponse": "", "starRating": 0, "tags": [] }
|
AnswerLibraryExtVO { alertText (string, optional): Alert text, example: TestAlertText alternateQuestions (string): Indicates alternate question, if any, example: Alternate question on details about your company answers (Array[Answer Text NameValuePair], mandatory): Indicates the responses to the questions, collectionList (Array[string], optional): Indicates the collection to which the Q&A pair belongs to, approvers (Array[string], optional): Indicates the approvers/moderators for the Q&A pair, customFields (Map<string, object>, optional): Indicates the optional custom fields, customReviewCycleInDays (integer, optional): Indicates the custom review cycle in days, dueDate (string, optional): Indicates the due date, editPrivacySetting (Array[string], optional): Indicates the privacy settings for editing the Q&A pair, enableReview (Boolean, optional): Indicates if review has to be enabled or not. followUpDates (Array[string], optional): Indicates the follow up dates, language (string, optional): Indicates the Q&A pair’s language, owners (Array[string], optional): Indicates the owner of the Q&A pair, primaryBU (string, optional): Indicates the primary business unit to which the answer belongs, privacySetting (Array[string], optional): Indicates the privacy setting for viewing the Q&A pair, projectName (string, optional): Indicates the Project Name, question (string): Indicates the Question, reviewFlag (boolean, optional): Content flag reviewWorkflow (string, optional): Review Workflow. Allowed Values are ["ANY", "ALL"], sectionName (string, optional): Indicates the Section Name, standardResponse (string, optional): Indicates a Standard Response, starRating (integer, optional): Indicates the star rating, tags (Array[string], optional): Indicates the answer’s tags, }
NameValuePair [ key (string, mandatory):Response Header, value (string, mandatory):Response Value ]
|
|
Output Sample Response |
JSON object. { "alertText": "TestAlertText", "alternateQuestions": "Alternate question on details about your company", "answers": [ { "key": "Response Header", "value": "Response Value" } ], "approvers": [], "collectionList": [], "companyId": "", "contentScore": 0, "contentType": "ANSWER", "createdBy": "", "createdDate": "2023-08-16T04:59:05.517Z", "customFields": {}, "customReviewCycleInDays": 0, "displayId": "", "dueDate": "", "editPrivacySetting": [], "enableReview": false, "followUpDates": [], "hasImage": false, "id": "", "language": "", "owners": [], "primaryBU": "India", "privacySetting": [], "projectName": "TestProjectName", "question": "Brief details about your company", "reviewFlag": false, "reviewWorkflow": "", "sectionName": "TestSection", "source": "", "standardResponse": "", "starRating": 0, "status": "", "tags": [], "updateBy": "", "updateDate": "2023-08-16T04:59:05.517Z" } |
|
Bulk Add Answer Library QA |
||
|
API URL |
/rfpserver/ext/v1/answer-lib/bulk-add |
|
|
Description |
Adds new content to the Answer Library. For authorization, use user’s API token. |
|
|
Type |
POST |
|
|
Input |
[ { "alertText": "TestAlertText", "alternateQuestions": "Alternate question on details about your company", "answers": [ { "key": "Response Header", "value": "Response Value" } ], "approvers": [], "collectionList": [], "customFields": {}, "customReviewCycleInDays": 0, "dueDate": "", "editPrivacySetting": [], "enableReview": false, "followUpDates": [], "language": "", "owners": [], "primaryBU": "India", "privacySetting": [], "projectName": "TestProjectName", "question": "Brief details about your company", "reviewFlag": false, "reviewWorkflow": "", "sectionName": "TestSection", "standardResponse": "", "starRating": 0, "tags": [] } ]
|
List[AnswerLibraryExtVO] { alertText (string, optional): Alert text, example: TestAlertText alternateQuestions (string): Indicates alternate question, if any, example: Alternate question on details about your company answers (Array[Answer Text NameValuePair], mandatory): Indicates the responses to the questions, collectionList (Array[string], optional): Indicates the collection to which the Q&A pair belongs to, approvers (Array[string], optional): Indicates the approvers/moderators for the Q&A pair, customFields (Map<string, object>, optional): Indicates the optional custom fields, customReviewCycleInDays (integer, optional): Indicates the custom review cycle in days, dueDate (string, optional): Indicates the due date, editPrivacySetting (Array[string], optional): Indicates the privacy settings for editing the Q&A pair, enableReview (Boolean, optional): Indicates if review has to be enabled or not. followUpDates (Array[string], optional): Indicates the follow up dates, language (string, optional): Indicates the Q&A pair’s language, owners (Array[string], optional): Indicates the owner of the Q&A pair, primaryBU (string, optional): Indicates the primary business unit to which the answer belongs, privacySetting (Array[string], optional): Indicates the privacy setting for viewing the Q&A pair, projectName (string, optional): Indicates the Project Name, question (string, mandatory): Indicates the Question, reviewFlag (boolean, optional): Content flag reviewWorkflow (string, optional): Review Workflow. Allowed Values are ["ANY", "ALL"], sectionName (string, optional): Indicates the Section Name, standardResponse (string, optional): Indicates a Standard Response, starRating (integer, optional): Indicates the star rating, tags (Array[string], optional): Indicates the answer’s tags, }
NameValuePair [ key (string, mandatory):Response Header, value (string, mandatory):Response Value ]
|
|
Output Sample Response |
JSON object. If the request is successful, 207 status is returned since it may have different status for each AL record. Response Schema: [ { "message": <string>, "answerLibVO": AnswerLibraryResponseExtVO, "status": integer } ] Response Body Example { "alertText": "TestAlertText", "alternateQuestions": "Alternate question on details about your company", "answers": [ { "key": "Response Header", "value": "Response Value" } ], "approvers": [], "collectionList": [], "companyId": "", "contentScore": 0, "contentType": "ANSWER", "createdBy": "", "createdDate": "2023-08-16T04:59:05.517Z", "customFields": {}, "customReviewCycleInDays": 0, "displayId": "", "dueDate": "", "editPrivacySetting": [], "enableReview": false, "followUpDates": [], "hasImage": false, "id": "", "language": "", "owners": [], "primaryBU": "India", "privacySetting": [], "projectName": "TestProjectName", "question": "Brief details about your company", "reviewFlag": false, "reviewWorkflow": "", "sectionName": "TestSection", "source": "", "standardResponse": "", "starRating": 0, "status": "", "tags": [], "updateBy": "", "updateDate": "2023-08-16T04:59:05.517Z" } |
|
AnswerLibraryResponseExtVO
| alertText |
string example: TestAlertText Alert Text |
| alternateQuestions |
string example: Alternate question on details about your company Alternate Question |
| answers* |
[Answer Text NameValuePair] |
| 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 ] |
| 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 |
| 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] |
| enableReview |
boolean Review Status of the Content |
| followUpDates |
[ Review Follow-Up Dates with format, yyyy-MM-dd string] |
| hasImage |
boolean Indicates if Q&A Pair has Image in the Response |
| id |
string Content Id |
| language |
string Language |
| owners |
[ List of Users who are assigned as Owners to the Content string] |
| primaryBU |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
| privacySetting |
[ List of Roles with view privacy settings string] |
| projectName |
string example: TestProjectName Project Name |
| question* |
string example: Brief details about your company Question Text |
| reviewFlag |
boolean Content Flag |
| reviewWorkflow |
string Review Workflow. Allowed Values are ["ANY", "ALL"] |
| sectionName |
string example: TestSection Section Name |
| source |
string Source of the Content |
| standardResponse |
string Standard Response |
| starRating |
integer($int32) Star Rating |
| status |
string Content Status |
| tags |
[ List of Tags string] |
| updateBy |
string User who updated the content |
| updateDate |
string($date-time) Updated timestamp of Content |
NameValuePair*
| key* |
string example: Response Header Response Header |
| value* |
string example: Response Value Response Value |
Image Download |
||
|
API URL |
/rfpserver/ext/v1/answer-lib/images/{companyId}/{fileId} |
|
|
Description |
Download image file from the Answer Library content. |
|
|
Type |
GET |
|
|
Input |
companyId and fileId in the URL |
In Answer Library records, if there are any images, each image will have companyId and fileId which can be used here to download the image. |
|
Output |
Image Blob |
|
Attachment Download |
||
|
API URL |
/rfpserver/ext/v1/answer-lib/attachments/{companyId}/{fileId} |
|
|
Description |
Download attachment file from the Answer Library content. |
|
|
Type |
GET |
|
|
Input |
companyId and fileId in the URL |
In Answer Library records, if there are any attachments, each attachment will have companyId and fileId which can be used here to download the file. |
|
Output |
Complete File |
|
Get Q&A Pair from Answer Library |
||
|
API URL |
/rfpserver/ext/v1/answer-lib/get/{id} |
|
|
Description |
Search for a Q&A pair in the answer library content by specifying the ID. |
|
|
Type |
GET |
|
|
Input |
ID in the URL |
In Answer Library records, each Q&A pair will have an unique ID, which can be specified here to retrieve details on that Q&A pair. |
|
Output |
JSON object containing the matching Q&A pair. HistoricalContentSearchResponseExtVO |
|
Update Details About a Q&A Pair API |
||
|
API URL |
/rfpserver/ext/v1/answer-lib/update/id |
|
|
Description |
Update details about a Q&A pair in the Answer Library. |
|
|
Type |
POST |
|
|
Input |
id |
The ID of the Q&A pair you want to update. Example: 5ffd460f39c5382dcf733e37 |
|
Input
(Request body) |
{ "alertText": "TestAlertText", "alternateQuestions": "Alternate question on details about your company", "answers": [ { "key": "Response Header", "value": "Response Value" } ], "approvers": [“test@client.com”], "collectionList": [], "customFields": {}, "customReviewCycleInDays": 0, "dueDate": "2023-07-02 22:30:00 -07:0", "editPrivacySetting": [], "enableReview": false, "followUpDates": [], "language": "", "owners": [“test@client.com”], "primaryBU": "India", "privacySetting": [], "projectName": "TestProjectName", "question": "Brief details about your company", "reviewFlag": false, "reviewWorkflow": "", "sectionName": "TestSection", "standardResponse": "", "starRating": 0, "tags": [] } |
AnswerLibraryExtVO { alertText (string, optional): Alert text, example: TestAlertText alternateQuestions (string): Indicates alternate question, if any, example: Alternate question on details about your company answers (Array[Answer Text NameValuePair], mandatory): Indicates the responses to the questions, collectionList (Array[string], optional): Indicates the collection to which the Q&A pair belongs to, approvers (Array[string], optional): Indicates the approvers/moderators for the Q&A pair, customFields (Map<string, object>, optional): Indicates the optional custom fields, customReviewCycleInDays (integer, optional): Indicates the custom review cycle in days, dueDate (string, optional): Indicates the due date, editPrivacySetting (Array[string], optional): Indicates the privacy settings for editing the Q&A pair, enableReview (Boolean, optional): Indicates if review has to be enabled or not. followUpDates (Array[string], optional): Indicates the follow up dates, language (string, optional): Indicates the Q&A pair’s language, owners (Array[string], optional): Indicates the owner of the Q&A pair, primaryBU (string, optional): Indicates the primary business unit to which the answer belongs, privacySetting (Array[string], optional): Indicates the privacy setting for viewing the Q&A pair, projectName (string, optional): Indicates the Project Name, question (string): Indicates the Question, reviewFlag (boolean, optional): Content flag reviewWorkflow (string, optional): Review Workflow. Allowed Values are ["ANY", "ALL"], sectionName (string, optional): Indicates the Section Name, standardResponse (string, optional): Indicates a Standard Response, starRating (integer, optional): Indicates the star rating, tags (Array[string], optional): Indicates the answer’s tags, }
NameValuePair [ key (string, mandatory):Response Header, value (string, mandatory):Response Value ] |
|
Output |
{ "id": "64d9b4d7e70c7258fd13b1d7", "projectName": "TestProjectName", "sectionName": "TestSection", "alertText": "TestAlertText", "standardResponse": "", "question": "Brief details about your company", "customFields": {}, "alternateQuestions": "Alternate question on details about your company", "answers": [ { "key": "Response", "value": "Response Value" } ], "tags": [], "privacySetting": [], "editPrivacySetting": [], "owners": ["test@client.com"], "approvers": ["test@client.com"], "language": "", "starRating": 0, "collectionList": [], "dueDate": ""2023-07-02 22:30:00 -07:00"", "followUpDates": [“2023-07-02 22:30:00 -07:00”], "customReviewCycleInDays": 0, "reviewWorkflow": "", "reviewFlag": false, "createdBy": "test@client.com", "updateBy": "test@client.com", "createdDate": "2023-08-13 22:00:07 -07:00", "updateDate": "2023-08-13 22:00:07 -07:00", "numUsed": 0, "businessUnits": [], "primaryBU": "India", "sharedBUs": [], "displayId": "", "skipReindex": false, "companyId": "", "contentType": "ANSWER", "status": "ACTIVE", "source": "NEWLY_ADDED", "contentScore": 0, "hasImage": false, "enableReview": false } |
|
Delete Q&A Pairs API |
||
|
API URL |
/rfpserver/ext/v1/answer-lib/delete |
|
|
Description |
Delete Q&A pairs from the Answer Library. It uses the Answer Library Search to get the idList of the pairs you want to delete, and that API call must include the limit parameter. The pair will remain in the Answer Library Trash for 30 days before being permanently deleted. |
|
|
Type |
POST |
|
|
Body |
{ "idList": [ "string" ], "isMoveToTrash": false } |
AnswerLibraryDeleteRequestVO idList(string, Mandatory): List of IDs for the Q&A pairs to be deleted
isMoveToTrash (Boolean, Optional) If value is set as true, the Q&A pair will be moved to trash and it can be recovered later, if needed. If value is set as false, the Q&A pair will be deleted permanently. The default value is false. |
|
Output |
If the Q&A pairs have been successfully moved to the Answer Library Trask, the response code will be 200 and the number of pairs that were moved. Example: [ { "DELETED_RECORDS": [ "64ddfff22e84ba166b726806" ], "status": 200 } ] |
|
List Collections API |
|
| API URL | /rfpserver/ext/v1/collections/list |
| Description | Gets the list of collections by applying various filters. Note: Partners collections are excluded in the results. |
| Type | POST |
| Input |
Example: { "collectionName": "", "limit": 25, "offset": 0, "primaryBU": "India", "users": [] } |
| Output |
If search is successful, the response will be CollectionsExternalResponseListVO. Example: { "collectionsVOList": [ { "companyId": "", "createdBy": "", "createdDate": "2023-08-16T10:44:34.436Z", "id": "", "lastUpdateTs": "2023-08-16T10:44:34.436Z", "name": "", "primaryBU": "India", "sharedBUs": [], "updatedBy": "", "users": [] } ], "limit": 0, "totalResultsCount": 0 } |
CollectionsSearchVO
| collectionName |
string Collection name |
| limit |
integer($int32) example: 25 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 |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
| users |
[ List of users who have access to collection string] |
CollectionsExternalResponseListVO
| collectionsVOList | [CollectionsExternalResponseVO] |
| limit |
integer($int32) Number of records to be fetched |
| totalResultsCount |
integer($int32) Total number of collection records matched |
CollectionsExternalResponseVO
| companyId |
string Company Id |
| createdBy |
string User who created the collection |
| createdDate |
string($date-time) Created timestamp of collection |
| id |
string Collection Id |
| lastUpdateTs |
string($date-time) Updated timestamp of collection |
| name |
string Collection name |
| primaryBU |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
| sharedBUs |
[ Shared Business Unit(s) Name to be associated. It is applicable only if business unit is enabled string] |
| updatedBy |
string User who updated the collection |
| users |
[ List of users who have access to Collection string] |
Create Collection API |
|
| API URL | /rfpserver/ext/v1/collections/add |
| Description | Create a new collection in a company |
| Type | POST |
| Input |
Example: { "collectionName": "TestCollection", "primaryBU": "India", "sharedBUs": [], "users": [ "ALL_USERS" ] } |
| Output |
Example: { "companyId": "", "createdBy": "", "createdDate": "2023-08-16T10:38:18.773Z", "id": "", "lastUpdateTs": "2023-08-16T10:38:18.773Z", "name": "", "primaryBU": "India", "sharedBUs": [], "updatedBy": "", "users": [] } |
CollectionsRequestVO
| collectionName* |
string example: TestCollection Collection name |
| primaryBU |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
| sharedBUs |
[ Shared Business Unit(s) Name to be associated. It is applicable only if business unit is enabled string] |
| users* |
[ example: List [ "ALL_USERS" ] List of users who have access to collection string] |
CollectionsExternalResponseVO
| companyId |
string Company Id |
| createdBy |
string User who created the collection |
| createdDate |
string($date-time) Created timestamp of collection |
| id |
string Collection Id |
| lastUpdateTs |
string($date-time) Updated timestamp of collection |
| name |
string Collection name |
| primaryBU |
string example: India Business Unit Name to be associated. This is mandatory only if business unit is enabled for the company |
| sharedBUs |
[ Shared Business Unit(s) Name to be associated. It is applicable only if business unit is enabled string] |
| updatedBy |
string User who updated the collection |
| users |
[ List of users who have access to Collection string] |
Example
Request:
https://dev1.rfpio.com/rfpserver/ext/v1/collections/add
Request Body:
{
"collectionName" : "Test-collections",
"users" : [
"johndoe@marvel.com","jane.doe@marvel.com"
],
"primaryBU" : "india",
"sharedBUs" : []
}
Response:
{
"id": "6154171a4783d11b505885b0",
"companyId": "608be394c788e6291b862706",
"createdDate": "2021-09-29T07:34:50.000+0000",
"lastUpdateTs": "2021-09-29T07:34:50.000+0000",
"createdBy": "johndoe@marvel.com",
"updatedBy": "johndoe@marvel.com",
"name": "Test-collections",
"users": [
"johndoe@marvel.com",
"jane.doe@marvel.com"
],
"primaryBU": "India"
}
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 ] |
| 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 |
| description |
string Content Description |
| displayId |
string Display Id |
| docVersion |
integer($int32) Document Version |
| downloadedCount |
integer($int32) Content Downloaded Count |
| dueDate |
string Review dueDate. It should be a future date with format, yyyy-MM-dd |
| editPrivacySetting |
[ List of Roles with edit privacy settings string] |
| fileId |
string File Id |
| fileType |
string File Type |
| 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 |
| name |
string File Name |
| 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 |
| size |
integer($int64) Document Size |
| 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 ] |
AnswerLibrarySearchVO
| cursor |
string example: * Next pagination start record |
| idsList |
List of content IDs to filter string |
| keyword |
string example: * Keyword in the content |
| limit |
integer($int32) example: 25 Count of 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. |
| createdToDate |
string($date-time) To filter the content with date range to the specified created date |
| metadata |
boolean To get the complete details of the content, set the metadata as true |
HistoricalAnswerLibrarySearchResponseList
| 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 | [HistoricalSearchResponseExtVO] |
| 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 |
HistoricalSearchResponseExtVO
| 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 Answer 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 ] |
| 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.