API for Decision Lens Accelerate

Swagger spec can be downloaded to generate client code.

This repository contains API's for Decision Lens Accelerate in several programming languages.

• java: The Java API
• R: The R API
• javascript: The JavaScript API

API Token

An API token is required to invoke APIs. This token can be generated using OAUth2 client credentials flow.

If your instance is running in the DL Cloud, call support to get API credentials for the user that will run integration. You can create a robot account user and get API credentials for this user. Make sure this robot account is in the portfolios that you want to integrate.

If you are running self-hosted instance call support to get instructions to generate API credentials.

Generate API Token

This sample code uses curl to show how to generate API token from API credentials.

curl -X POST -H -u "client_id:client_secret" "https://api-gov.decisionlens.com/oauth/token?grant_type=client_credentials" -v

The curl call above will return a response with access_token. The API access token is valid for 12 hours.

Invoking APIs

Once you have the API access token you are ready to invoke APIs.

An example API call to fetch all the portfolios that the user has access to

curl -X GET "https://api-gov.decisionlens.com/v1/portfolios" -H "Authorization: <paste your access token here>"

Uploading a spreadsheet (.xlsx) to update project data in the portfolio

Here is an sample code to update a spreadsheet to update project data in the portfolio.

1. Add a new portfolio. Get portfolio id from the response.

curl -X POST 'https://api.-gov.decisionlens.com/v1/portfolios'  -H 'authorization: Bearer <paste your access token here>' -H 'content-type: application/json'  -d '{"name":"Test Portfolio","isCombined":false,"attributes":{"timeInterval":{"type":"FISCAL_YEAR","startMonth":9},"budgetTimePeriodType":"YEAR","isMonthlySpendPlan":true}}'

2. Upload a spreadsheet. Populate the full file name in the request. Get spreadsheet id from the response

curl -X POST 'https://api-gov.decisionlens.com/v1/spreadsheet'  -H 'authorization: Bearer <paste your access token here>' --form 'file=@"<full file name>"'

3. Save the data in the worksheet from the uploaded spreadsheet to the portfolio. Populate portfolioId, spreadsheetId and sheetName in the URL.

curl -X POST https://api-gov.decisionlens.com/v1/portfolios/{portfolioId}/spreadsheet/{spreadsheetId}?sheetName={sheetName}&importType=PROJECT -H 'authorization: Bearer <paste your access token here>'

Downloading project data

Download project data in the portfolio plan as an Excel file (.xlsx). In order to export data you need to get the portfolio plan id. For example, in order to export from baseline plan:

1. Get portfolio plans for the portfolio. Iterate over the portfolio plans and get the id of the basline portfolio plan.

curl -X GET 'https://api-gov.decisionlens.com/v1/portfolioPlans?portfolioId={portfolioId} -H 'authorization: Bearer <paste your access token here>'

2. Export all project data

curl -X POST https://api-gov.decisionlens.com/v1/portfolioPlans/{portfolioPlanId}/export?exportType=PROJECT&exportFormat=XLSX -H 'authorization: Bearer <paste your access token here>' -H 'Content-Type: application/json' -o projects.xlsx