SOURCE API Help Page

Introduction

SOURCE Api provides several methods to facilitate integration and exchanges between SOURCE and external platforms.
This page is the automatically generated documentation for the Api, just provided for reference.
As a guideline to fully implement SOURCE Api usage, please use the implementation guide available here.

ProjectTimeline

Provides web methods related to project timeline. These methods require an account with access to the project identified by its Guid

API	Description
GET projects/{projectId}/timeline/tasks/{taskId}	Gets a task by its Id
GET projects/{projectId}/timeline/tasks/search/{sourceId}/{packageId}	Gets a task by its Id in SOURCE templates
PUT projects/{projectId}/timeline/tasks/{taskId}/completion	Completes a task
PUT projects/{projectId}/timeline/tasks/{taskId}/status	Reviews a task

GlobalIndicators

Provides web methods related to global indicators These methods require an account with "API Public" role

API	Description
GET GlobalIndicators/SourceApplication	Returns all global indicators related to SOURCE application.
GET GlobalIndicators/SourceApplication/{id}	Returns a global indicator related to SOURCE application by its Id.
GET GlobalIndicators/SourceApplication/{name}	Returns a global indicator related to SOURCE application by its name.
GET GlobalIndicators/sdg	Returns indicators related to SDGs, based on user organisation
GET GlobalIndicators/sdg/{name}	Returns an indicator related to SDGs, based on user organisation and indicator id

ProjectRequests

Provides web methods related to published projects. These methods require an account with "API Organisation services" role

API	Description
GET project-requests/archived	No documentation available.
GET project-requests/{projectRequestId}	No documentation available.
PUT project-requests/archived	No documentation available.
GET ProjectRequests	No documentation available.
POST ProjectRequests	No documentation available.
GET ProjectRequests/GetActiveRequests	No documentation available.
POST ProjectRequests/Create	No documentation available.

DelveApi

API	Description
GET _vti_bin/DelveApi.ashx/{version}/attachments?messageId={messageId}&attachmentId={attachmentId}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/{userId}?expand={expand}	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/people/me/settings/delveflags	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/userprofile/delveflags/{flag}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/me/settings/isgraphenabled	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/people/me/settings/isgraphenabled	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/people/me/mru	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/{actorId}/peers?top={top}&skip={skip}&expand={expand}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/{actorId}/directs?top={top}&skip={skip}&expand={expand}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/{actorId}/managers?top={top}&skip={skip}&expand={expand}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/{actorId}/workingwith?top={top}&skip={skip}&expand={expand}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/{actorId}/commoncolleagues?top={top}&skip={skip}&expand={expand}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/{actorId}/relatedpeople?top={top}&skip={skip}&expand={expand}&excludeTypes={excludeTypes}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/profileimage?token={token}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/people/{userId}/profiledata?expand={expand}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/userprofile/delveflags/{flag}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/userprofile/haslegacyblog?oneDriveUrl={oneDriveUrl}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/search/tags?queryText={queryText}&top={top}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/boards?actorId={actorId}&boardName={boardName}&expand={expand}&top={top}&skip={skip}&extraProperties={extraProperties}&activityTagIds={activityTagIds}&queryFilter={queryFilter}&excludeTypes={excludeTypes}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/boards/{actorId}/{boardName}?expand={expand}&top={top}&skip={skip}&extraProperties={extraProperties}&activityTagIds={activityTagIds}&queryFilter={queryFilter}&excludeTypes={excludeTypes}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/boards/{actorId}?boardName={boardName}&expand={expand}&top={top}&skip={skip}&extraProperties={extraProperties}&activityTagIds={activityTagIds}&queryFilter={queryFilter}&excludeTypes={excludeTypes}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/relatedcontent/{docid}?excludeTypes={excludeTypes}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/search/people?queryText={queryText}&excludeIds={excludeIds}&top={top}&skip={skip}&lcid={lcid}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/search/documents?queryText={queryText}&top={top}&skip={skip}&lcid={lcid}&extraProperties={extraProperties}&excludeTypes={excludeTypes}&expand={expand}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/license/isdelveenabled	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/groups?groupId={groupId}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/groups/joinedGroups?userId={userId}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/groups/ismember?groupId={groupId}&userId={userId}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/groups/isowner?groupId={groupId}&userId={userId}	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/groups/join?groupId={groupId}	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/groups/leave?groupId={groupId}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/tags?documentIds={documentIds}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/tags/lookup?title={title}&onlyFollowed={onlyFollowed}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/tags/followed?top={top}	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/signals/elevated	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/signals/shown	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/signals/clicked	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/signals/feedconsumed	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/signals/batch	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/yammer/commentcounts	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/praise/{userName}/all?startDate={startDate}&endDate={endDate}&includePostedBy={includePostedBy}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/praise/{userName}/given?startDate={startDate}&endDate={endDate}&includePostedBy={includePostedBy}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/praise/{userName}/received?startDate={startDate}&endDate={endDate}&includePostedBy={includePostedBy}	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/praise/{userName}?skipEmailNotification={skipEmailNotification}	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/praise/{praiseId}/like	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/praise/{praiseId}/unlike	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/content/oembed?url={url}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/documents?documentIds={documentIds}&extraProperties={extraProperties}	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/documents/follow	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/documents/unfollow	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/documents/preview?siteId={siteId}&webId={webId}&uniqueId={uniqueId}&token={token}&docId={docId}&index={index}&resolution={resolution}&listItemId={listItemId}	No documentation available.
GET _vti_bin/DelveApi.ashx/{version}/tags/suggestions?queryText={queryText}&limit={limit}	No documentation available.
POST _vti_bin/DelveApi.ashx/{version}/notifications/register	No documentation available.

Projects

Provides web methods related to projects.

API	Description
GET projects/{projectId}	Returns a project.
PUT projects/{projectId}	Returns a project.
GET Projects	Returns all projects.
GET Projects/Get	Returns all projects.

ProjectIndicators

Provides web methods related to project indicators. These methods require an account with access to the project identified by its Guid

API	Description
GET projects/{projectId}/indicators	Gets the list of indicators
GET projects/{projectId}/indicators/{indicatorId}/{packageId}/values	Gets indicator values
GET projects/{projectId}/indicators/{indicatorId}/{packageId}/params	Gets indicator settings

PublishedProjects

Provides web methods related to published projects. These methods require an account with "API Public" role

API	Description
GET PublishedProjects/{languageCode}	Returns all published projects.
POST PublishedProjects/{languageCode}	Returns published projects matching with some search criterias.
GET PublishedProjects/{projectId}/{languageCode}	Returns a published project
GET PublishedProjects/{projectId}/{documentId}	Returns a published document.
GET PublishedProjects/{projectId}/assessments/{assessmentId}	Return a published assessment report

ProjectQuestions

Provides web methods related to project questions. These methods require an account with access to the project identified by its Guid

API	Description
GET projects/{projectId}/questions/{questionId}	Gets a question by its Id
GET projects/{projectId}/questions/search/{sourceId}	Gets a question by its Id in SOURCE templates
PUT projects/{projectId}/questions/{questionId}/answer	Submits an answer to a project question
PUT projects/{projectId}/questions/{questionId}/status	Reviews an answer to a project question

Documents

Provides web methods related to published projects. These methods require an account with "API Public" role

API	Description
POST documents/upload/{projectId}	Uploads a document. 1st step: document metadata
PUT documents/upload/{projectId}/{id}	Uploads a document. 2nd step: document content
GET documents/upload/{projectId}/{id}	Gets a pending document upload request.
GET documents/{projectId}/{id}	Returns a document.

ReferenceData

Provides web methods related to reference data. These methods require an account with "API Public" role

API	Description
GET ReferenceData/legal-frameworks/{territoryId}	Returns all available values for Legal Framework.
GET ReferenceData/technical-supports/{territoryId}	Returns all available values for Technical Support.
GET ReferenceData/thresholds/{territoryId}	Returns all available values for Threshold.
GET ReferenceData/tender-processes/{territoryId}	Returns Returns all available values for Tender Process.
GET ReferenceData/contractual-arrangements/{territoryId}	Returns Returns all available values for Contractual Arrangements.
GET ReferenceData/activity-status/{territoryId}	Returns Returns all available values for Contractual Arrangements.
GET ReferenceData/Territories	Returns all territories.
GET ReferenceData/Sectors	Returns all sectors.
GET ReferenceData/currencies	Returns all currencies.
GET ReferenceData/Subsectors	Returns all subsectors.
GET ReferenceData/terms/{termSetName}	Returns all terms from a termset.
GET ReferenceData/project-types	Returns all project types.
GET ReferenceData/status/project/{territoryId}	Returns available status for a territory
GET ReferenceData/status/application	Returns available status for an application

ProxyGdi

Provides proxy to use GDI Api methods.

API	Description
POST Proxy/Gdi/DeliveryChallenges	Gets delivery challenges from GDI Api according to search criteria.

Backup

Provides web methods related to published projects. These methods require an account with "API Organisation services" role

API	Description
GET Backup/Projects	Gets archive with all projects available for the organisation service account.
GET Backup/{projectId}/{documentId}	Returns a document.