Session-based APIs

Our publicly available Session-based APIs provide system interaction at a user level. Access to data and services depends on the requesting user’s privileges. See your account manager or system administrator for privileges.

HTTP Headers

Session based API calls require a username and token to be set as HTTP headers.

x-auth-user	User’s username
x-auth-token	The session token provided by users/auth

Example:

curl --request DELETE \
  --url https://hostname/users/auth \
  --header 'content-type: application/json' \
  --header 'x-auth-token: 1-555-555-1212' \
  --header 'x-auth-user: joe.user'

API Categories

• Authentication
• User Session
• users/me
• Assets
• Digital Assets
• IAT (Intelligent Asset Tracking)
• Assignments
• Service on Demands
• Actions on Demand (in Key Based APIs)
• Location Actions
• Location Service requests (reflections)
• Get assigned actions by action completion IDs CSV (Admin Only)
• Action Completion
• Service Request (Reflection) Completion
• Action Note
• Action Delegation
• Un-delegate an action
• Extend the due date-time for actions
• Extend the due date-time for service requests (aka reflections)
• Set JSON context for an action completion ID (Admin Only)
• Get action status for actions published but not yet due for a given location ID
• Reporting
• analyticsv2/actionEvidenceSpreadsheetReport
• analyticsv2/aggregateTaskListMetricsForLgV2
• analyticsv2/scorecardReport
• analyticsv2/scorecardLGAggReport
• analyticsv2/rankedMCSITaskScores
• analyticsv2/aggregateLgMetricsForDueDateRange
• analyticsv2/aggregateLocationMetricsForTaskListLg
• analyticsv2/actionStatusQuantityForLocationGroupWithDateRange
• analyticsv2/actionStatusPercentageAndCountForLocationGroupsWithDateRange
• analyticsv2/dailyActionStatsForLocationGroupWithDateRange
• users/userTopLevelLocGroupsContainingLocns
• analyticsv2/reflectionAcceptedAndFailedWOUpdateCounts
• analyticsv2/reflectionsResolvedPrematurelyReport
• analyticsv2/topReflectedRankings
• analyticsv2/orgRollupReport
• org/format
• actionlist/listCompletionCounts
• Task Lists
• Create a New task list
• Update an existing task list
• Read an existing task list detail.
• Create a new task in a task list
• Delete a task list
• Get on-demand templates that the user is permitted to send (assign)
• Get tasks by task IDs CSV (Admin Only)
• Python Sample Code
• Tasks
• Create a new parent task
• Update parent task
• Create an Evidence Collection task (task template)
• Create a Multiple Choice Single Selection task (task template)
• Delete a task (task template)
• Get all tasks under a task list template
• Admin
• Users
• Locations
• Formats
• Meta
• users/myLocations