Table of contents

• Introduction 
• Authorization
• Finding Your Endpoints
• All Endpoints in Newest Version
  • Activity
  • Authorization
  • Calendar
  • FieldsOption
  • IlapFile
  • MetadataField
  • MetadataFieldValue
  • PlanningSchedule
  • Profile
  • ReportSchedule
  • ReportScheduleBatchOperation
  • ReportScheduleRegeneration
  • ReportScheduleType
  • Resource
  • Validation

Introduction 

The REST API exposes a set of predefined endpoints that allows for data manipulation (learn more about REST APIs here.)
As ILAP Analytics is a self hosted solution the exact amount of endpoints may differ between solutions, but each solution comes with a set that each solution running the newest version should have. 

Authorization

The REST API uses Bearer Authentication when you communicate with the API. Attach a header with the tokens like this:

{
"Authorization": "Bearer {token}",
"Content-Type": "application/json"
}

{
"Authorization": "IlapAnalyticsToken {token}",
"Content-Type": "application/json"
}

In all instances of the solution, you should be able to access {your-api-url}/swagger/index.html when you set it up. This swagger documentation gives you a full overview over all available endpoints. If this documentation is not available, please contact the person responsible for managing the system.

All Endpoints in Newest Version

Activity

Endpoints under this category provide access to Activity entries. Activities represent a planned work item. To see the reported information about an activity, see ReportActivity endpoints.

GET /api/Schedules/{scheduleId}/Activities

Summary: Get endpoint to manage Activities

Parameters:

• scheduleId (path) required

Authorization

Handles user and service identity verification. This includes endpoints for token-based authentication, user profile access (MySelf), and management of service account tokens (create, read, update, delete).

POST /api/Authentication/Verify

Summary: Post endpoint for authentication operations

GET /api/Authentication/MySelf

Summary: Get endpoint for authentication operations

POST /api/Authentication/ServiceAccountTokens

Summary: Post endpoint for authentication operations

GET /api/Authentication/ServiceAccountTokens

Summary: Get endpoint for authentication operations

PUT /api/Authentication/ServiceAccountTokens/{id}

Summary: Put endpoint for authentication operations

Parameters:

• id (path) required

DELETE /api/Authentication/ServiceAccountTokens/{id}

Summary: Delete endpoint for authentication operations

Parameters:

• id (path) required

Calendar

Supports interaction with planning calendars tied to project schedules. Calendars define working and non-working time, key for accurate schedule calculations.

GET /api/Schedules/{scheduleId}/Calendars

Summary: Get endpoint for calendar operations

Parameters:

• scheduleId (path) required
• includeCalendarOperations (query)

FieldsOption

Provides valid selectable options for certain metadata or fields in ILAP. These options help standardize filtering and user input across the system.

GET /api/Fields/Options/{fieldName}

Summary: Get endpoint to manage Options

Parameters:

• fieldName (path) required

IlapFile

Manages ILAP files, which are structured data packages uploaded into the system. Includes support for tracking import progress and file-specific metadata.

GET /api/IlapFile/{id}

Summary: Get endpoint for ilapfile operations

Parameters:

• id (path) required:

GET /api/IlapFile/{id}/Status

Summary: Get endpoint for ilapfile operations

Parameters:

• id (path) required

MetadataField

Handles metadata field definitions used to annotate schedules and activities. These fields are customizable attributes defined per implementation.

GET /api/MetadataField/{id}

Summary: Get endpoint for metadatafield operations

Parameters:

• id (path) required

PUT /api/MetadataField/{id}

Summary: Put endpoint for metadatafield operations

Parameters:

- id (path) required

DELETE /api/MetadataField/{id}

Summary: Delete endpoint for metadatafield operations

Parameters:

• id (path) required

GET /api/MetadataField

Summary: Get endpoint for metadatafield operations

Parameters:

• includeUsage (query)

POST /api/MetadataField

Summary: Post endpoint for metadatafield operations

GET /api/MetadataFields

Summary: Get endpoint for metadatafield operations

POST /api/MetadataFields

Summary: Post endpoint for metadatafield operations

POST /api/MetadataFields/Bulk

Summary: Post endpoint for metadatafield operations

GET /api/MetadataField/ReportSchedule/{reportScheduleId}

Summary: Get endpoint for metadatafield operations

Parameters:

• reportScheduleId (path) required

GET /api/MetadataField/IlapDataExchangeFields

Summary: Get endpoint for metadatafield operations

MetadataFieldValue

Allows interaction with values assigned to metadata fields on ILAP objects (e.g., a specific field's value on an activity or file).

GET /api/MetadataFieldValue/{id}

Summary: Get endpoint for metadatafieldvalue operations

Parameters:

• id (path) required

PUT /api/MetadataFieldValue/{id}

Summary: Put endpoint for metadatafieldvalue operations

Parameters:

• id (path) required

DELETE /api/MetadataFieldValue/{id}

Summary: Delete endpoint for metadatafieldvalue operations

Parameters:

• id (path) required.

GET /api/MetadataFieldValue

Summary: Get endpoint for metadatafieldvalue operations

POST /api/MetadataFieldValue

Summary: Post endpoint for metadatafieldvalue operations

POST /api/MetadataFieldValues

Summary: Post endpoint for metadatafieldvalue operations

PlanningSchedule

Relates to the core schedule data in ILAP—imported from external planning systems (like Primavera). It represents the foundation of all timeline-related analytics.

PUT /api/PlanningSchedule/{id}

Summary: Put endpoint for planningschedule operations

Parameters:

• id (path) required

DELETE /api/PlanningSchedule/{id}

Summary: Delete endpoint for planningschedule operations

Parameters:

• id (path) required

GET /api/ReportSchedules/{reportScheduleId}/Types/{type}/PlanningSchedule

Summary: Get endpoint for planningschedule operations

Parameters:

• reportScheduleId (path) required
• type (path) required
• cutOff (query)

GET /api/ReportSchedules/{reportScheduleId}/Types/{revisionType}/PlanningScheduleCutoffs

Summary: Get endpoint for planningschedule operations

Parameters:

• reportScheduleId (path) required
• revisionType (path) required

Profile

A profile represents resource usage by an activity.

GET /api/Schedules/{scheduleId}/Profiles

Summary: Get endpoint for profile operations

Parameters:

• scheduleId (path) required

ReportSchedule

The main container for schedule data. Contains the reported schedule activity.

POST /api/ReportSchedule

Summary: Post endpoint for reportschedule operations

GET /api/ReportSchedule

Summary: Get endpoint for reportschedule operations

POST /api/ReportSchedule/Revision/Change

Summary: Post endpoint for reportschedule operations

POST /api/ReportScheduleWithMetadataFieldValue

Summary: Post endpoint for reportschedule operations

PUT /api/ReportSchedule/{id}

Summary: Put endpoint for reportschedule operations

Parameters:

• id (path) required

DELETE /api/ReportSchedule/{id}

Summary: Delete endpoint for reportschedule operations

Parameters:

• id (path) required

GET /api/ReportSchedule/{id}

Summary: Get endpoint for reportschedule operations

Parameters:

• id (path) required

POST /api/ReportSchedule/{id}

Summary: Post endpoint for reportschedule operations

Parameters:

• id (path) required

PUT /api/ReportSchedule/{id}/Status

Summary: Put endpoint for reportschedule operations

Parameters:

• id (path) required

GET /api/ReportSchedule/{id}/schedules

Summary: Get endpoint for reportschedule operations

Parameters:

• id (path) required

GET /api/ReportSchedules

Summary: Get endpoint for reportSchedule operations

GET /api/ReportSchedule/{id}/activities

Summary: Get endpoint for reportschedule operations

Parameters:

• id (path) required
• includeMetadata (query)

GET /api/ReportSchedule/{id}/operations/processing

Summary: Get endpoint for reportschedule operations

Parameters:

• id (path) required

GET /api/ReportSchedule/{id}/operations/failed

Summary: Get endpoint for reportschedule operations

Parameters:

• id (path) required

POST /api/ReportSchedule/Baseline/{id}

Summary: Post endpoint for reportschedule operations

Parameters:

• id (path) required

POST /api/ReportSchedule/OriginalBaseline/{id}

Summary: Post endpoint for reportschedule operations

Parameters:

• id (path) required

POST /api/ReportSchedule/Current/{id}

Summary: Post endpoint for reportschedule operations

Parameters:

• id (path) required

POST /api/ReportSchedule/{id}/{type}/Revert

Summary: Post endpoint for reportschedule operations

Parameters:

• id (path) required
• type (path) required

GET /api/ReportSchedules/{id}/PointsInTimeType

Summary: Get endpoint for reportschedule operations

Parameters:

• id (path) required

ReportScheduleBatchOperation

Batch operations for report schedules.

DELETE /api/ReportScheduleBatchOperations/{id}

Summary: Delete endpoint for reportschedulebatchoperation operations

Parameters:

• id (path) required

POST /api/ReportScheduleBatchOperations/BackgroundJobs/{id}

Summary: Post endpoint for reportschedulebatchoperation operations

Parameters:

• id (path) required

ReportScheduleRegeneration

Endpoints for regenerating report schedules.

POST /api/ReportSchedules/Regenerate

Summary: Post endpoint to manage Regenerate

ReportScheduleType

Endpoints to manage report schedule types.

POST /api/ReportScheduleType

Summary: Post endpoint for reportscheduletype operations

GET /api/ReportScheduleType

Summary: Get endpoint for reportscheduletype operations

Parameters:

• includeMetaDataFieldValues (query)

POST /api/ReportScheduleTypeWithMetadata

Summary: Post endpoint for reportscheduletype operations

PUT /api/ReportScheduleType/{id}

Summary: Put endpoint for reportscheduletype operations

Parameters:

• id (path) required

DELETE /api/ReportScheduleType/{id}

Summary: Delete endpoint for reportscheduletype operations

Parameters:

• id (path) required

GET /api/ReportScheduleType/{id}

Summary: Get endpoint for reportscheduletype operations

Parameters:

• id (path) required
• planningObjectTypes (query)

GET /api/ReportScheduleTypes

Summary: Get endpoint for reportscheduletype operations

ReportScheduleTypeMetadataField

Metadata for report schedule types

POST /api/ReportScheduleTypeMetadataField

Summary: Post endpoint for reportscheduletypemetadatafield operations

Resource

List resources connected to a schedule

GET /api/Schedules/{scheduleId}/Resources

Summary: Get endpoint for resource operations

Parameters:

• scheduleId (path) required

Validation

Endpoint to validate report schedules against different baselines

POST /api/Validate/ReportSchedule/{id}

Summary: Post endpoint to validate ReportSchedule

Parameters:

• id (path) required

POST /api/Validate/ReportSchedule/Baseline/{id}

Summary: Post endpoint to validate against Baseline

Parameters:

• id (path) required

POST /api/Validate/ReportSchedule/OriginalBaseline/{id}

Summary: Post endpoint to validate against OriginalBaseline

Parameters:

• id (path) required

POST /api/Validate/ReportSchedule/Current/{id}

Summary: Post endpoint to validate against Current report schedule

Parameters:

• id (path) required