API
      Back to home
      1. Help Center
      2. Scorecard Documentation
      3. API

      API: Actions

      The API enables the following interactions with tags:

      Explanation of Action Parameters

      • assignedBy [string] - The username (email address) this action is assigned to
      • assignedTo [string] - The username (email address) this action is assigned by
      • description [string] - Action description
      • endDate [dateTime] - Action end date
      • percentComplete [int] - Percent completion, between 0-100
      • primaryTag[string] - The tag used for categorizing this object, between 1-15 characters. You can enter a tag that already exists, or enter a new tag and it will be created.
      • startDate [dateTime] - Action start date
      • actionStatus [int]* - Action status ID - see list below
      • title [string]* - Action name

      Action Status IDs

      • 1 - On Track
      • 2 - Behind Schedule
      • 3 - Ahead of Schedule
      • 4 - Cancelled
      • 5 - Completed
      • 6 - Not Started
      • 7 - N/A

      Get List of Actions

      URL

      https://api.resultsscorecard.com/api/actions/list

      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

      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

      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

      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

      JSON Input

      {
      siteCode: "abc",
      apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
      id:2
      }

      JSON Output

      Successfully deleted action [id].