Registration Now Open! Join "Mastering Business Transformation – Strategies for Success", the second installment of our three-part webinar series on Strategic Pain Points. Choose the time that works best for you and secure your spot today!Available Sessions:
May 21st at 10 AM CST ➡️ Register Now!
May 21st at 6:30 PM CST ➡️ Register Now!
x

Impact Connector

Includes a set of inbound and outbound APIs that connect to the Amplify software. The inbound operations allow the creation, update, and deletion of impacts. The outbound operations allow the retrieval of complete Impact lists or the specification of particular Impacts. Impacts are available with all of their associated parameters.

Operations
Create a new impact
Return a list of impacts
Delete a specific impact
Update a specific impact
Return a specific impact

Create a new impact

This inbound API can be used to create a new impact.
Name
Description
impact*
Impact
Responses
Code
Description
201
Impact created
Example:

{
 “id”: 0,
 “name”: “string”,
 “description”: “string”,
 “resolution”: “string”,
 “start_date”: “2022-12-05”,
 “end_date”: “2022-12-05”,
 “classification”: {
   “id”: 0,
   “name”: “string”,
   “type”: “string”,
   “custom_fields”: [
     {
       “id”: 0,
       “name”: “string”,
       “type”: “string”,
       “options”: [
         {
           “id”: “string”,
           “label”: “string”,
           “value”: “string”
         }
       ],
       “required”: true,
       “value”: [
         “string”
       ]
     }
   ]
 },
 “initiative”: {
   “id”: 0,
   “name”: “string”
 },
 “owner”: {
   “id”: 0,
   “name”: “string”,
   “email”: “string”
 },
 “unit”: {
   “id”: 0,
   “name”: “string”
 },
 “recurring”: true,
 “disbenefit”: true,
 “weight”: 0,
 “custom_fields”: [
   {
     “id”: 0,
     “name”: “string”,
     “type”: “string”,
     “options”: [
       {
         "id": "string",
         "label": "string",
         "value": "string"
       }
     ],
     "required": true,
     "value": [
       "string"
     ]
   }
 ],
 "external_id": "string",
 "active": true
}

‍

Return a list of impacts

This outbound API can be used to retrieve a list of impacts.
Name
Description
initiative_id*
initiative_id
Responses
Code
Description
200
Impacts retrieved
Example:

[
 {
   “id”: 0,
   “name”: “string”,
   “description”: “string”,
   “resolution”: “string”,
   “start_date”: “2022-12-05”,
   “end_date”: “2022-12-05”,
   “classification”: {
     “id”: 0,
     “name”: “string”,
     “type”: “string”,
     “custom_fields”: [
       {
         “id”: 0,
         “name”: “string”,
         “type”: “string”,
         “options”: [
           {
             “id”: “string”,
             “label”: “string”,
             “value”: “string”
           }
         ],
         “required”: true,
         “value”: [
           “string”
         ]
       }
     ]
   },
   “initiative”: {
     “id”: 0,
     “name”: “string”
   },
   “owner”: {
     “id”: 0,
     “name”: “string”,
     “email”: “string”
   },
   “unit”: {
     “id”: 0,
     “name”: “string”
   },
   “recurring”: true,
   “disbenefit”: true,
   “weight”: 0,
   “custom_fields”: [
     {
       “id”: 0,
       “name”: “string”,
       “type”: “string”,
       "options": [
         {
           "id": "string",
           "label": "string",
           "value": "string"
         }
       ],
       "required": true,
       "value": [
         "string"
       ]
     }
   ],
   "external_id": "string",
   "active": true
 }
]

‍

Delete a specific impact

This inbound API can be used to delete a selected impact.
Name
Description
id*
Id
Responses
Code
Description
204
Impact deleted
Example:

{
 “id”: 0,
}

‍

Update a specific impact

This inbound API can be used to update a selected impact.
Name
Description
id*
Id
Responses
Code
Description
200
Impact updated
Example:

{
 “id”: 0,
 “name”: “string”,
 “description”: “string”,
 “resolution”: “string”,
 “start_date”: “2022-12-05”,
 “end_date”: “2022-12-05”,
 “classification”: {
   “id”: 0,
   “name”: “string”,
   “type”: “string”,
   “custom_fields”: [
     {
       “id”: 0,
       “name”: “string”,
       “type”: “string”,
       “options”: [
         {
           “id”: “string”,
           “label”: “string”,
           “value”: “string”
         }
       ],
       “required”: true,
       “value”: [
         “string”
       ]
     }
   ]
 },
 “initiative”: {
   “id”: 0,
   “name”: “string”
 },
 “owner”: {
   “id”: 0,
   “name”: “string”,
   “email”: “string”
 },
 “unit”: {
   “id”: 0,
   “name”: “string”
 },
 “recurring”: true,
 “disbenefit”: true,
 “weight”: 0,
 “custom_fields”: [
   {
     “id”: 0,
     “name”: “string”,
     “type”: “string”,
     “options”: [
       {
         "id": "string",
         "label": "string",
         "value": "string"
       }
     ],
     "required": true,
     "value": [
       "string"
     ]
   }
 ],
 "external_id": "string",
 "active": true
}

‍

Return a specific impact

This outbound API can be used to retrieve a selected impact.
Name
Description
id*
Id
Responses
Code
Description
200
Impact retrieved
Example:

{
 “id”: 0,
 “name”: “string”,
 “description”: “string”,
 “resolution”: “string”,
 “start_date”: “2022-12-05”,
 “end_date”: “2022-12-05”,
 “classification”: {
   “id”: 0,
   “name”: “string”,
   “type”: “string”,
   “custom_fields”: [
     {
       “id”: 0,
       “name”: “string”,
       “type”: “string”,
       “options”: [
         {
           “id”: “string”,
           “label”: “string”,
           “value”: “string”
         }
       ],
       “required”: true,
       “value”: [
         “string”
       ]
     }
   ]
 },
 “initiative”: {
   “id”: 0,
   “name”: “string”
 },
 “owner”: {
   “id”: 0,
   “name”: “string”,
   “email”: “string”
 },
 “unit”: {
   “id”: 0,
   “name”: “string”
 },
 “recurring”: true,
 “disbenefit”: true,
 “weight”: 0,
 “custom_fields”: [
   {
     “id”: 0,
     “name”: “string”,
     “type”: “string”,
     “options”: [
       {
         "id": "string",
         "label": "string",
         "value": "string"
       }
     ],
     "required": true,
     "value": [
       "string"
     ]
   }
 ],
 "external_id": "string",
 "active": true
}

‍

Keep in touch

* required

Amplify’s strategic program management solution empowers companies to navigate the rapid pace of change and deliver on their promise

Product
Why Amplify
About us
Contact us
© 2022 Amplify-Now    |    Privacy Policy      
The Capterra logo is a service mark of Gartner, Inc. and/or its affiliates and is used herein with permission. All rights reserved.