How to work with Actions through the Clear Impact Scorecard API.
Explanation of Action Parameters
assignedBy
[string] - The username (email address) this Action is assigned toassignedTo
[string] - The username (email address) this Action is assigned bydescription
[string] - A description for the Action.endDate
[dateTime] - The end date for this ActionpercentComplete
[int] - Number between 0-100 for how complete this Action is.primaryTag
[string] - String between 1-15 characters. This is the Clear Impact Scorecard tag used for categorizing this object. You can enter a tag that already exists to be linked or enter a new tag that does not exist and it will be created.startDate
[dateTime] - The start date for this ActionactionStatus
[int]* - The ID of the status for this Action. See list of statuses below.title
[string]* - The name of the Action
Allowed Action Status ID's
1
- On Track2
- Behind Schedule3
- Ahead of Schedule4
- Cancelled5
- Completed6
- Not Started7
- N/A
Get list of Actions
URL
https://api.resultsscorecard.com/api/actions/list
XML Input
<?xml version="1.0"?>
<Parameters>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
</Parameters>
XML Output
<ArrayOfAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Action>
<assignedBy>email@domain.org</assignedBy>
<assignedTo>email@domain.org</assignedTo>
<createDate>2013-10-01T00:00:00</createDate>
<createdBy>email@domain.org</createdBy>
<description>This is a test action</description>
<endDate>2013-10-22T00:00:00</endDate>
<ID>1</ID>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-10-01T00:00:00</modifyDate>
<percentComplete>13</percentComplete>
<primaryTag>ThisIsATag</primaryTag>
<startDate>2013-10-01T00:00:00</startDate>
<statusId>1</statusId>
<title>new action</title>
</Action>
<Action>
<assignedBy>email@domain.org</assignedBy>
<assignedTo>email@domain.org</assignedTo>
<createDate>2013-11-13T09:56:39.35</createDate>
<createdBy>email@domain.org</createdBy>
<description>This is a newest test action</description>
<endDate>2013-10-22T00:00:00</endDate>
<ID>2</ID>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-11-13T09:56:39.35</modifyDate>
<percentComplete>13</percentComplete>
<primaryTag>ThisIsATag</primaryTag>
<startDate>2013-10-01T00:00:00</startDate>
<statusId>1</statusId>
<title>newest action</title>
</Action>
</ArrayOfAction>
JSON Input
{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO"
}
JSON Output
[
{
"ID": 1,
"statusId": 1,
"assignedBy": "email@domain.org",
"assignedTo": "email@domain.org",
"title": "new action",
"description": "This is a test action",
"startDate": "2013-10-01T00:00:00",
"endDate": "2013-10-22T00:00:00",
"percentComplete": 13,
"primaryTag": "ThisIsATag",
"createDate": "2013-10-01T00:00:00",
"createdBy": "email@domain.org",
"modifyDate": "2013-10-01T00:00:00",
"modifiedBy": "email@domain.org"
},
{
"ID": 2,
"statusId": 1,
"assignedBy": "email@domain.org",
"assignedTo": "email@domain.org",
"title": "newest action",
"description": "This is a newest test action",
"startDate": "2013-10-01T00:00:00",
"endDate": "2013-10-22T00:00:00",
"percentComplete": 13,
"primaryTag": "ThisIsATag",
"createDate": "2013-11-13T09:56:39.35",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-13T09:56:39.35",
"modifiedBy": "email@domain.org"
}
]
Add an Action
URL
https://api.resultsscorecard.com/api/actions/add
XML Input
<Action>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>DEV</siteCode>
<assignedBy>email@domain.org</assignedBy>
<assignedTo>email@domain.org</assignedTo>
<description>Action Description</description>
<endDate>2014-04-09</endDate>
<percentComplete>13</percentComplete>
<primaryTag>ThisIsATag</primaryTag>
<startDate>2014-04-09</startDate>
<statusId>1</statusId>
<title>Action Name123</title>
</Action>
XML Output
<Action xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<assignedBy>email@domain.org</assignedBy>
<assignedTo>email@domain.org</assignedTo>
<createDate>2014-04-14T22:47:29.0054288+00:00</createDate>
<createdBy>email@domain.org</createdBy>
<description>Action Description</description>
<endDate>2014-04-09T00:00:00</endDate>
<ID>3361</ID>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2014-04-14T22:47:29.0054288+00:00</modifyDate>
<percentComplete>13</percentComplete>
<primaryTag>ThisIsATag</primaryTag>
<startDate>2014-04-09T00:00:00</startDate>
<statusId>1</statusId>
<title>Action Name123</title>
</Action>
JSON Input
{
"siteCode": "abc",
"apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
"statusId": 1,
"assignedBy": "email@domain.org",
"assignedTo": "email@domain.org",
"title": "new action",
"description": "This is a test action",
"startDate": "2013-10-01T00:00:00",
"endDate": "2013-10-22T00:00:00",
"percentComplete": 13,
"primaryTag": "ThisIsATag"
}
JSON Output
{
"ID": 4,
"statusId": 1,
"assignedBy": "email@domain.org",
"assignedTo": "email@domain.org",
"title": "new action",
"description": "This is a test action",
"startDate": "2013-10-01T00:00:00",
"endDate": "2013-10-22T00:00:00",
"percentComplete": 13,
"primaryTag": "ThisIsATag",
"createDate": "2013-11-13T21:14:45.2702743-08:00",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-13T21:14:45.2702743-08:00",
"modifiedBy": "email@domain.org"
}
Get Action Details
URL
https://api.resultsscorecard.com/api/actions/details
XML Input
<?xml version="1.0"?>
<Parameters>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<ID>6</ID>
</Parameters>
XML Output
<?xml version="1.0"?>
<Action xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<assignedBy>email@domain.org</assignedBy>
<assignedTo>email@domain.org</assignedTo>
<createDate>2013-10-01T00:00:00</createDate>
<createdBy>email@domain.org</createdBy>
<description>This is a test action</description>
<endDate>2013-10-22T00:00:00</endDate>
<ID>1</ID>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-10-01T00:00:00</modifyDate>
<percentComplete>13</percentComplete>
<primaryTag>ThisIsATag</primaryTag>
<startDate>2013-10-01T00:00:00</startDate>
<statusId>1</statusId>
<title>new action</title>
</Action>
JSON Input
{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
id:1
}
JSON Output
{
"ID": 1,
"statusId": 1,
"assignedBy": "email@domain.org",
"assignedTo": "email@domain.org",
"title": "new action",
"description": "This is a test action",
"startDate": "2013-10-01T00:00:00",
"endDate": "2013-10-22T00:00:00",
"percentComplete": 13,
"primaryTag": "ThisIsATag",
"createDate": "2013-10-01T00:00:00",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-13T21:29:25.81211-08:00",
"modifiedBy": "email@domain.org"
}
Update an Action
URL
https://api.resultsscorecard.com/api/actions/update
XML Input
<?xml version="1.0"?>
<Action>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<assignedBy>email@domain.org</assignedBy>
<assignedTo>email@domain.org</assignedTo>
<description>This is a newest test action</description>
<endDate>2013-10-22T00:00:00</endDate>
<ID>1</ID>
<percentComplete>13</percentComplete>
<primaryTag>ThisIsATag</primaryTag>
<startDate>2013-10-01T00:00:00</startDate>
<statusId>1</statusId>
<title>newest action</title>
</Action>
XML Output
<?xml version="1.0"?>
<Action xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<assignedBy>1</assignedBy>
<assignedTo>1</assignedTo>
<createDate>2013-10-01T00:00:00</createDate>
<createdBy>email@domain.org</createdBy>
<description>This is a test action</description>
<endDate>2013-10-22T00:00:00</endDate>
<ID>1</ID>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-11-13T21:21:24.8281071-08:00</modifyDate>
<percentComplete>13</percentComplete>
<primaryTag>ThisIsATag</primaryTag>
<startDate>2013-10-01T00:00:00</startDate>
<statusId>1</statusId>
<title>newest action</title>
</Action>
JSON Input
{
"siteCode": "abc",
"apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
"statusId": 1,
"assignedBy": "email@domain.org",
"assignedTo": "email@domain.org",
"ID":1,
"title": "new action",
"description": "This is a test action",
"startDate": "2013-10-01T00:00:00",
"endDate": "2013-10-22T00:00:00",
"percentComplete": 13,
"primaryTag": "ThisIsATag"
}
JSON Output
{
"ID": 1,
"statusId": 1,
"assignedBy": "email@domain.org",
"assignedTo": "email@domain.org",
"title": "new action",
"description": "This is a test action",
"startDate": "2013-10-01T00:00:00",
"endDate": "2013-10-22T00:00:00",
"percentComplete": 13,
"primaryTag": "ThisIsATag",
"createDate": "2013-10-01T00:00:00",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-13T21:29:25.81211-08:00",
"modifiedBy": "email@domain.org"
}
Delete an Action
URL
https://api.resultsscorecard.com/api/actions/delete
XML Input
<?xml version="1.0"?>
<Action>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<ID>1</ID>
</Action>
XML Output
Successfully deleted action [id].
JSON Input
{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
id:2
}
JSON Output
Successfully deleted action [id].