Dataverse custom APIs

Use these approved Custom APIs to integrate with Altus. Review each generated contract before calling an operation.

API	Method	Summary
sensei_assignmentbyday	POST	Return assignment hours by day for a project.
sensei_bulkcreatefiscalperiods	POST	Create multiple fiscal periods from a supplied period definition.
sensei_bulkcreatetimesheetperiods	POST	Create multiple timesheet periods from a supplied period definition.
sensei_deleteexternalttasks	POST	Delete external tasks for a specified external project.
sensei_deletetasks	POST	Delete tasks for a specified external project.
sensei_materialiseschedule	POST	Materialise a stored project schedule into Dataverse records.
sensei_ratebyday	POST	Retrieve resource rates for a specified date range.
sensei_getratebyday	GET	Retrieve resource rates for a specified date range by using a Dataverse function.
sensei_resreqratecalcbyday	POST	Calculate resource-request cost or sell values for a specified date range.
sensei_getresreqratecalcbyday	GET	Calculate resource-request cost or sell values by using a Dataverse function.
sensei_resourcetofinancesync	POST	Synchronize Resource Plan data into the Finance Grid.
sensei_timesheettotasksync	POST	Synchronize approved timesheet data to tasks.
sensei_unlinkfinancials	POST	Unlink imported financial data from a project.
sensei_unlinkproject	POST	Disconnect an Altus project from its externally synchronized source.
sensei_uploadandmaterialiseschedule	POST	Upload an external schedule and synchronize it with a linked Altus project.

Assignment By Day (sensei_assignmentbyday)

Returns Assignment By Day data

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_assignmentbyday
Binding	Unbound

Request parameters

Name	Type	Required
aggregationType	String	No
finish	Date and time	No
includeprotectedactuals	Boolean	No
includeRelatedNamedResources	Boolean	No
projectid	GUID	Yes
resourceids	String array	No
start	Date and time	No
taskids	String array	No
totalsonly	Boolean	No

Response properties

Name	Type
data	String

Bulk Create Fiscal Periods (sensei_bulkcreatefiscalperiods)

Allows bulk creation of FiscalPeriods

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_bulkcreatefiscalperiods
Binding	Unbound

Request parameters

Name	Type	Required
dateFormat	String	No
numberOfPeriods	Integer	Yes
periodDuration	Integer	Yes
periodDurationUnit	String	Yes
periodNameTemplate	String	Yes
sequenceSeed	Integer	No
start	Date and time	Yes

Response properties

Name	Type
message	String
result	String

Bulk Create Timesheet Periods (sensei_bulkcreatetimesheetperiods)

Allows bulk creation of Timesheet Periods

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_bulkcreatetimesheetperiods
Binding	Unbound

Request parameters

Name	Type	Required
dateFormat	String	No
numberOfPeriods	Integer	Yes
periodDuration	Integer	Yes
periodDurationUnit	String	Yes
periodNameTemplate	String	Yes
sequenceSeed	Integer	No
start	Date and time	Yes

Response properties

Name	Type
message	String
result	String

Delete External Tasks (sensei_deleteexternalttasks)

Delete External Tasks

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_deleteexternalttasks
Binding	Unbound

Request parameters

Name	Type	Required
deleteexternaltasksTop	Integer	Yes
externalProjectGUID	String	Yes

Response properties

Name	Type
message	String
result	String

Delete Tasks (sensei_deletetasks)

Delete Tasks

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_deletetasks
Binding	Unbound

Request parameters

Name	Type	Required
deletetasksTop	Integer	Yes
externalProjectGUID	String	Yes

Response properties

Name	Type
message	String
result	String

Materialise Schedule (sensei_materialiseschedule)

Materialise schedule for linked project from stored schedule

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_materialiseschedule
Binding	Unbound

Request parameters

Name	Type	Required
projectId	GUID	Yes

Response properties

Name	Type
message	String

Rate By Day (sensei_ratebyday)

Retrieves a Bookable Resources Rates for a given period

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_ratebyday
Binding	Unbound

Request parameters

Name	Type	Required
bookableresourceid	GUID	Yes
finish	Date and time	Yes
includeprojectoverrides	Boolean	No
projectid	GUID	No
proposalid	GUID	No
ratetype	String	Yes
start	Date and time	Yes

Response properties

Name	Type
data	String
message	String

Rate By Day (GET) (sensei_getratebyday)

Retrieves a Bookable Resources Rates for a given period (via GET)

Property	Value
Method	GET
Endpoint	/api/data/v9.2/sensei_getratebyday
Binding	Unbound

Request parameters

Name	Type	Required
bookableresourceid	GUID	Yes
finish	Date and time	Yes
includeprojectoverrides	Boolean	No
projectid	GUID	No
proposalid	GUID	No
ratetype	String	Yes
start	Date and time	Yes

Response properties

Name	Type
data	String
message	String

Resource Request Rate Calculation By Day (sensei_resreqratecalcbyday)

Returns a Resource Request Cost or Sell Calculation

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_resreqratecalcbyday
Binding	Unbound

Request parameters

Name	Type	Required
bookableresourceid	GUID	Yes
finish	Date and time	Yes
projectid	GUID	No
proposalid	GUID	No
ratetype	String	Yes
start	Date and time	Yes

Response properties

Name	Type
data	String
message	String
totalapprovedhours	Decimal
totalapprovedvalue	Money
totaldrafthours	Decimal
totaldraftvalue	Money

Resource Request Rate Calculation By Day (GET) (sensei_getresreqratecalcbyday)

Returns a Resource Request Cost or Sell Calculation (via GET)

Property	Value
Method	GET
Endpoint	/api/data/v9.2/sensei_getresreqratecalcbyday
Binding	Unbound

Request parameters

Name	Type	Required
bookableresourceid	GUID	Yes
finish	Date and time	Yes
projectid	GUID	No
proposalid	GUID	No
ratetype	String	Yes
start	Date and time	Yes

Response properties

Name	Type
data	String
message	String
totalapprovedhours	Decimal
totalapprovedvalue	Money
totaldrafthours	Decimal
totaldraftvalue	Money

Resource to Finance Sync (sensei_resourcetofinancesync)

Synchronises data from Resource Plan into Finance Grid

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_resourcetofinancesync
Binding	Unbound

Request parameters

Name	Type	Required
parententity	String	Yes
parentid	GUID	Yes
zoomlevel	String	Yes

Response properties

Name	Type
data	String
message	String
summary	String

Timesheet to Task Sync (sensei_timesheettotasksync)

Synchronises data from Timesheets to Tasks

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_timesheettotasksync
Binding	Unbound

Request parameters

Name	Type	Required
parententity	String	Yes
parentid	GUID	Yes

Response properties

Name	Type
data	String
message	String
summary	String

Unlink Financials (sensei_unlinkfinancials)

Unlink Imported Financials

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_unlinkfinancials
Binding	Unbound

Request parameters

Name	Type	Required
projectId	GUID	Yes

Response properties

Name	Type
message	String

Unlink Project (sensei_unlinkproject)

Unlink External Project

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_unlinkproject
Binding	Unbound

Request parameters

Name	Type	Required
deleteFlag	Boolean	Yes
projectId	GUID	Yes

Response properties

Name	Type
message	String

Upload and Materialise Schedule (sensei_uploadandmaterialiseschedule)

Upload a schedule in a format like MPP and synchronize it with a linked project in Altus

Property	Value
Method	POST
Endpoint	/api/data/v9.2/sensei_uploadandmaterialiseschedule
Binding	Unbound

Request parameters

Name	Type	Required
documentProperties	String	No
fileData	String	No
fileName	String	No
projectId	GUID	Yes
systemType	String	Yes

Response properties

Name	Type
message	String