Background and strategic fit
Background and strategic fit
The purpose of this Integration is to pull over different profileinformation profile information to support our growing customer base to analyze the data they are entering through the ProcessMAP solution. This document provides information on how to consume the API's by the end Users.
Assumptions
Individual APIs being used for profile information.
ProcessMAP system User permissions would not be considered while exposing the data
ProcessMAP assumes anyone who is accessing the Outbound API has required authority to access Personal Information
User would have to input single Location Code(e.g. Westlake) each time to consume that Location data
Data to be accessed with a limitation of 2 years duration at a time to avoid any performance issues.
Data will be shown in Readable JSON format
Fields Names in the Response would be Product Field Naming. Customer will have to use mapping documentation
User accessing this endpoint through a valid Token & ConsumerId, provided by ProcessMAP, will have access to complete data
DATETIME, INT and FLOAT data will be shown as NULL when there is no data
The data that is being shown in response is in EST Date time format ONLY
User Interaction
Operational Profile
Profile Details
Request
GET /iapi/opm/profiles?locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncedDate={lastSyncedDate}
...
Name | Description | Sample |
|---|---|---|
Authorization | Represents the value of the authentication token. | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ... |
ConsumerId | Represents the value of the consumer id. | 2426 |
Response
Sample:
| Code Block |
|---|
[
{
"Operational Profile": {
"Details": {
"Location Code": "WestLake",
"Profile Month": "April 2021",
"Profile Name": "Sample",
"Effective From": "2021-04-01T00:00:00.000Z",
"Effective Till": "2021-04-30T00:00:00.000Z",
"Profile Owners": "Sample1,Sample2"
},
"Profile Filters": {
"Protocol": "Sample",
"Activity Filter": "Sample",
"Question": [
{
"Question Title": "Sample",
"Response": "No"
},
{
"Question Title": "Sample1",
"Response": "No"
},
{
"Question Title": "Sample2",
"Response": "No"
}
]
},
"Additional Profile Details": {
"Created By": "Sample",
"Created Date": "2021-04-30T17:38:50.047Z",
"Last Updated By": "Sample",
"Updated Date": "2021-04-30T17:39:28.747Z"
},
"Action Item Details": [
{
"Action Item ID": "US-RESEARCH PARK-2021-OPM-AI-00061",
"Action Item Title": "Sample",
"Action Item Description": "Sample",
"Action Item Due Date": "2021-05-10T00:00:00.000Z",
"Primary Owners": "Sample",
"Response": "Response Yes",
"Score": 50.00,
"Action Item Status": "Closed",
"Comments": "mm",
"Action Item Completed By": "Sample",
"Action Item Completed Date": "2021-05-10T00:00:00.000Z",
"Last Updated By": "Sample",
"Updated Date": "2021-05-10T00:00:00.000Z"
},
{
"Action Item ID": "US-RESEARCH PARK-2021-OPM-AI-0002",
"Action Item Title": "Sample1",
"Action Item Description": "Sample1",
"Action Item Due Date": "2021-05-10T00:00:00.000Z",
"Primary Owners": "Sample1",
"Response": "Response Yes",
"Score": 50.00,
"Action Item Status": "Closed",
"Comments": "mm",
"Action Item Completed By": "Sample",
"Action Item Completed Date": "2021-05-10T00:00:00.000Z",
"Last Updated By": "Sample",
"Updated Date": "2021-05-10T00:00:00.000Z"
}
]
}
}
] |
Section | Field Name | Database Column Size |
|---|---|---|
Details | ||
Location Code | nvarchar(50) | |
Profile Month | nvarchar(100) | |
Profile Name | nvarchar(100) | |
Effective From | datetime | |
Effective Till | datetime | |
Profile Owners | nvarchar(4000) | |
Profile Filters | ||
Protocol | nvarchar(100) | |
Activity Filter | nvarchar(100) | |
Profile Filters >> Question | ||
Question Title | nvarchar(50) | |
Response | nvarchar(50) | |
Additional Profile Details | ||
Created By | nvarchar(100) | |
Created Date | datetime | |
Last Updated By | nvarchar(100) | |
Updated Date | datetime | |
Action Item Details | ||
Action Item ID | nvarchar(200) | |
Action Item Title | nvarchar(500) | |
Action Item Description | nvarchar(4000) | |
Primary Owners | nvarchar(4000) | |
Response | nvarchar(100) | |
Score | int | |
Action Item Status | nvarchar(100) | |
Comments | nvarchar(4000) | |
Action Item Completed By | nvarchar(100) | |
Action Item Completed Date | datetime | |
Last Updated By | nvarchar(100) | |
Updated Date | datetime | |
Errors/Validation Messages
...