Save as PDF

Company APIs

The Responsive application currently supports the following Company APIs:

Company API

Get Organizational Activities

API URL

/rfpserver/ext/v1/company/activities

Description

Gets the list of Organizational Activities by applying various filter.

Type

POST

Input

(path param)

{

  "entityType": "ANSWER_LIBRARY",

 

 

 

 

 

  "activityType": "CREATED",

 

 

 

 

 

 

 

 

 

   "owners": [   "serah@abc.com"

  ],

   "fromDate": "2019-10-14 22:33:26 -07:00",

 

  "toDate": "2019-10-16 22:33:26 -07:00",

 

  "limit": 5,

 

 "lastActivityId": null

}

 entityType (stringoptional): Indicates the entity type. Multiple values can be passed. Accepted values are: ANSWER_TYPE_TEMPLATE, EXPORT_TEMPLATE, SECTION_TEMPLATE, VENDORS, ANSWER_LIBRARY, DOCUMENT_LIBRARY, MASTER_DATA, PREFERENCES, COMPANY, USERS, INTEGRATION, SECTION_GROUP, PROJECT, CUSTOM_STOPWORDS, CUSTOM_FIELD, AL_COLLECTION, TASK_TEMPLATE, INTAKE_REQUEST, WORKFLOW, SUPPORT_ACCESS_CONTROL, USER_ACCOUNT, RELATED_WORDS, BUSINESS_UNITS, SOLUTION_TEMPLATE, SOLUTION, CUSTOM_ROLE, PROPOSAL_TEMPLATE, EMAIL_TEMPLATE, PROJECT_NOTES, or SAVED_SEARCH

 

activityType (stringoptional): Indicates the type of activity. Multiple values can be passed. Accepted values are: CREATED, EDITED, DELETED, ARCHIVED UNARCHIVED, TRASH, IN_PROGRESS, QUESTION_CREATED, QUESTION_EDITED, QUESTION_DELETED, VENDOR_CONTACT_ADDED, VENDOR_CONTACT_EDITED, VENDOR_CONTACT_DELETED, COMPANY_ACTIVATED, FILE_ADDED, FILE_DELETED, TASK_CREATED, TASK_COMPLETED, REVIEW_COMPLETED, MODERATION, PUBLISHED, REJECTED, GUEST_ADDED, GUEST_EDITED, GUEST_DELETED, CONVERTED, COMMENT_ADDED, COMMENT_EITDED, COMMENT_DELETED, IMPORTED, EXPORTED, MODERATION_IMPORTED, MODERATION_EXPORTED, USER_ADDED, SUPPORT_ADDED, SUPPORT_EDITED, SUPPORT_DELETED, CONTENT_MERGED, CONTEXT_CREATED, CONTEXT_DELETED, CONTEXT_EDITED, OWNERSHIP_REASSIGNED, CONTENT_SHARED, or RESET.

  

owners (Array[string]optional): Indicates the owners whose activity has to be fetched.

 

fromDate (stringoptional): Indicates the date from which activities should be fetched.

 

toDate (stringoptional): Indicates the date to which activities should be fetched.

 

limit (integeroptional): Indicates the count of activities to be fetched. By default, the limit is 100. Limit value should be less than or equal to 100. If limit is greater than 100, the system defaults the limit to 100. 

lastActivityId (stringoptional): Indicates the ID of the last activity performed. 

Output

JSON object containing details of activities fetched.

{

  "activities":

[

    {

      "id": "5da6aba69b2ffe56f218fc2e",

      "companyId": "5d19efb7a167e26d88c36e32",

      "performedBy": "serah@abc.com",

      "activityDate": "2019-10-15 22:33:26 -07:00",

      "newValues":

{

        "Answers":

[

          "<div>Yes</div><div>No</div><div>NA</div>"

        ],

        "Primary Business Unit": "APAC",

        "Star Rating": 3,

        "Question": "Select from the following",

        "Edit Privacy": "Everyone",

        "Flag": false,

        "View Privacy": "Everyone"

      },

      "additionalProperties":

{

        "Answers_datatype": "RICH_TEXT"

      },

      "type": "CREATED",

      "typeDescription": "message.ACTIVITY_PROJECT_CREATED",

      "entityName": "Select from the following",

      "entityType": "ANSWER_LIBRARY",

      "entityTypeDescription": "ANSWER_LIBRARY",

      "entityId": "5da6aba59b2ffe56f218fc2d"

    }

  ]

 

Get Chat Messages

API URL

/rfpserver/ext/v1/company/get-chat-messages

Description

Gets the chat messages of the company by applying various filter

Type

POST

Input

(path param)

{

  "recipients": [

    "john@abc.com"

  ],

  "senders": [

    "serah@abc.com"

  ],

  "fromDate": "2019-01-14T10:19:46.425Z",

 

  "toDate": "2020-01-25T06:15:28.976Z",

  "limit": 100,

 

 

  "lastMessageId": "5e2a8c3999837c4e12b2a047"

}

ChatSearchExternalVO {

recipients (Array[string]optional): Indicates the message recipients. Multiple values can be specified.,

 

senders (Array[string]optional): Indicates the message sender name.,

 

 

fromDate (date-timeoptional): To filter the messages with date range from the specified date,

 

toDate (date-timeoptional): To filter the messages with date range to the specified date,

limit (integeroptional): Limit is to specify the number of messages to be retrieved. Limit value should be less than or equal to 100. If limit is greater than 100, the system defaults the limit to 100., 

lastMessageId (stringoptional): Number of messages is retrieved based on the limit specified. To get the next set of records, copy the ID of the last message in the response and provide that value in the request's lastMessageId param and hit the API again.

}

Output

JSON object containing the list of chat messages.

{   

"id": "5e2a8c3499837c4e12b2a046",   

"message": "<span>Test</span>",   

"messageText": "Test",   

"recipients":

[     

"john@abc.com"   

],   

"sender": "serah@abc.com",   

"date": "Thu, 23 Jan 2020 22:18:28 -0800" 

}, 

{   

"id": "5e2a8c2a99837c4e12b2a045",   

"message": "<span>Hi</span>",   

"messageText": "Hi",   

"recipients":

[     

"john@abc.com"   

],   

"sender": "serah@abc.com",   

"date": "Thu, 23 Jan 2020 22:18:18 -0800" 

}

]

 

Get Metadata List

API URL /rfpserver/ext/v1/company/entity-metadata
Description Gets the list of metadata(custom field) information group-wise in a sorted manner based on the entity type.
Type GET

Input

(path param)

entityType

 


Mandatory

 

 

fieldType

The entity can be PROJECT or ANSWER_LIBRARY or INTAKE. This will filter only metadata that is specific to that entityType 

 

It can be true or false. True will fetch only mandatory fields

 

It can be STANDARD or CUSTOM. This filter can be used to get only CUSTOM or STANDARD fields

Output

 

JSON object containing the list of metadata(custom field) information group-wise in a sorted manner based on the entity type. 

{

    "entityType": "PROJECT",

    "metadataGroupList": [

        {

            "groupName": "Basic Details",

            "fields": [

                {

                    "id": "5c415d1034ff91377fac22e6",

                    "internalName": "name",

                    "displayName": "Deal Name",

                    "type": "TEXT_BOX",

                    "allowedValues": [],

                    "mandatory": true,

                    "groupName": "Basic Details",

                    "sortingOrder": 1.01,

                    "fieldType": "STANDARD",

                    "applicableToProjectTypes": [

                        "ALL"

                    ]

                }

            ]

        }

    ]

}

 

 

Entity Metadata

API URL /rfpserver/ext/v1/company/entity-metadata/{id}
Description Gets the metadata(field) information of the given id.
Type GET

Input

(path param)

fieldId Id of the field to fetch details about it.

Output

 

Sample Response

JSON object containing the metadata(field) information of the given id. 

{

    "id": "6009b3e6326ea2041479b789",

    "internalName": "team",

    "displayName": "Team",

    "type": "TEXT_BOX",

    "allowedValues": [],

    "mandatory": true,

    "groupName": "Custom Field",

    "sortingOrder": 6.02,

    "fieldType": "CUSTOM",

    "applicableToProjectTypes": [

        "RFP",

        "RFI"

    ]

}

 

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.

Was this article helpful?

/