Articles in this section

See more

02/24 Beta API Update

Avatar
Chris McLain
Updated
Follow

Beta API Update 02/24/2016

Speed and Reliability

In addition to all the updates below we have spent a lot of time working on speed enhancements for the API. Many of these you may have already been using as they have been published in the background. This is an area where we are dedicating a lot of effort and there is always ways to improve so you can be sure we will continue to work on this.

Added Routes

    • Route: "/me/accountabilities"
    • Return Object: List of Accountabilities
    • Description: Read Accountabilities for the currently logged in Individual.
    • Route: "/me/basicroles"
    • Return Object: List of Basic Roles
    • Description: Read basic roles for the currently logged in Individual.
    • Route: "/dialogs/{ancestorid:guid}/comments"
    • Return Object: Comment
    • Description: Read all comments for a dialog by Dialog ID.
    • Notes: This call was missing from the list of Comment calls.
    • Route: "/users"
    • Return Object: List of Individuals (Same as /individuals
    • Route: "/users/{userId}"
    • Return Object: Individual (Same as /individuals/{Id})
    • Route: "/log"
    • Optional Parameters: maxCount, FromDate, ToDate
    • Return Object: Log
    • Description: Read Site log entries of the site for the currently logged in Individual.
    • Route: "/sites/{id:guid}/log"
    • Optional Parameters: maxCount, FromDate, ToDate
    • Return Object: Log
    • Description: Read log entries for the given site ID.
    • Route:
      • "/organizations/{id:guid}/log"
      • "/departments/{id:guid}/log"
      • "/projects/{id:guid}/log"
      • "/tasks/{id:guid}/log"
      • "/individuals/{id:guid}/log"
      • "/metrics/{id:guid}/log"
      • "/dialogs/{id:guid}/log"
    • Optional Parameters: maxCount, FromDate, ToDate
    • Return Object: Log
    • Description: Read Log entries by Object ID.
    • Route: "/me/log"
    • Optional Parameters: maxCount, FromDate, ToDate
    • Return Object: Log
    • Description: Read Log entries for the currently logged in individual page.
    • Route: "/me/userlog"
    • Optional Parameters: maxCount, FromDate, ToDate
    • Return Object: Log
    • Description: Read Log entries for the currently logged in user.

 

    • Route: "/user/{id:guid}/log"
    • Optional Parameters: maxCount, FromDate, ToDate
    • Return Object: Log
    • Description: Read Logs for the given User
  • Route: "/individuals/{id:guid}/userlog"
  • Optional Parameters: maxCount, FromDate, ToDate
  • Return Object: Log
  • Description: Read user logs for the given individual by ID.

Updated Routes:

  • Phase had an incorrect route: projectphases/sites/{id}/projectphases was corrected to be /sites/{id}/projectphases
  • ProjectScope had an incorrect route: /projectscopes/{id}/undeleted was corrected to be projectscopes/{id}/undelete
  • Supervisory Scopes had an incorrect route: /individual/{individualid}/supervisoryscope/{id} was corrected to be /individuals/{individualid}/supervisoryscopes/{id}
  • Dashboard Routes were set to Dashboard. These have been deprecated and will no longer be used. They will continue to work if you are currently using them but we ask that you change your settings at your earliest convenience.

Deprecated fields

In the Individual object, Password and UserEmail have been deprecated. Password can still be passed in when creating an individual to set their password. It was and will not be passed out. These fields may be removed at a later date.

Deprecated Routes

Anyone currently using the API will have noticed all the update calls now take an ID. This was updated to be inline with Rest principles. Don't worry nothing you are currently doing will break as we have added the new routes in addition to the old. We have already removed the old routes from the help and will eventually remove them from the API(Not anytime soon so don't worry). Please use the new routes from now on.

Object Changes

Site object:
Feature API, Feature Outlook, and Feature Performance were returning null. They now return correctly

Misc Fixes

Corrected two errors on Create. When creating a task the color was not being set correctly. And when creating an Organization the rank wasn't being set correctly

Removed the ability to request deleted security groups. Deleted security groups are not being stored or recoverable so this feature has been removed.

Extra additions

We added extra error reporting on our side. This will allow us to monitor errors and preemptively fix them when we see something going wrong. Of course we ask that anytime you receive an error you need help with please put in a ticket.

(Wording!!!!)

Added a Boolean value of SendEvalSurvey to the Individual object. Currently this is a read only field to denote if an individual will receive eval surveys or not.

Validation Errors

In this update if any routes you used disappeared do not worry they will still work we are just removing them due to their deprecated status. If you have any questions or concerns about this please feel free to contact us at support@connectionsonline.net

Added validation error reporting. If you get an error on an Update or Create it may contain validation information in it. Anything that is marked as required will throw a validation error if not included in your object. The validation error will let you know what is wrong.

DateTime: Timezone

Added timezone information to the DateTime object. The server will always send the time out in the server's local time, which is Eastern Time.

Documentation

Clarified the coloring of the label for Required and ReadOnly. Previously they were the same color. Now the difference is much more noticeable.

Task.Color's description more accurately reflects the actual field.

Added GA to the Security Group documentation. This call should have been marked as Global Admin only because you can't view the default groups unless you are a global admin.

Updated help docs for Commitment to be more clear on what type to pass in for the call to GET dashboards/{ancestorId}/commitments/{type}?period={period}

Changed the help docs in permissions to more accurately reflect the childtypes you can pass in to each call. Removed numbers that will not give you a return from the route that you choose.

Bug Fixes

Fixed a bug that would try to get a list of metric owners even if no metrics were found. This was causing a Internal Server Error. This has been changed to not look for owners if there are no metrics.

Fixed a bug in basicroles - undelete was set to be a httpGet method when it should have been a httpPut

Fixed a bug in creating departments. When attempting to create a department the department would be created but when returning the route created at message the route would throw a 500 error. This has been fixed and will no longer error.

Fixed issue with Core Values where Rank was being returned as a byte? instead of an int?. This would make the call give a 404 error.

Misc.

Additionally in this update we have added a new "report".

Active Project Task Report: This report shows a list of all the currently active projects/tasks on a your site. With the Current Project Status, Task Status Start/End Dates and the people Responsible with the number of hours they have currently inputted for that task. You can find this report under the Getting Started section of the Beta API Site or go here: Active Project Tasks

Comments

0 comments

Please sign in to leave a comment.