Process Scopes API

The Process Scopes REST API enable you to manage scopes and determine the project implementation scope in SAP Cloud ALM.

Documentation

SAP Business Accelerator Hub: https://api.sap.com/api/CALM_PM/resourceInformation published on SAP site

Type

Pull API

URL Format

https://{tenant}.{region}.alm.cloud.sap/api/calm-processmanagement/v1

Process Management Operations for Scopes

  • GET /scopes: Retrieve all scopes

  • POST /scopes: Create a scope

  • GET /scopes/$count: Count scopes

  • GET /scopes/{id}: Get scope by ID

  • PATCH /scopes/{id}: Update a scope

  • DELETE /scopes/{id}: Delete a scope

Process Management Operations for Solution Scenario Versions

  • GET /scopes/{id}/solutionScenarioVersions: Retrieve assigned solution scenario versions of a scope

  • POST /scopes/{id}/solutionScenarioVersions: Assign one solution scenario version or multiple solution scenario versions, identified by its id, to a scope

  • GET /scopes/{id}/solutionScenarioVersions/$count: Get the number of solution scenario versions of a scopes

  • GET /solutionScenarioVersions: Get a list of solution scenario versions filtered by the given query parameters

  • GET /solutionScenarioVersions/$count: Get the total number of solution scenario versions

  • GET /solutionScenarioVersions/{id}: Get a distinct solution scenario version identified by ID

Process Management Operations for Solution Processes

  • GET /solutionProcesses: Get a list of solution process scopes and their scope statuses

  • GET /solutionProcesses/$count: Get the number of solution processes with the given filter criteria

  • PATCH /solutionProcesses/scopeAssignments: Update scope process assignment

Authorizations

Users require the calm-api.processmanagement.read, calm-api.processmanagement.write, and calm-api.processmanagement.delete scope for full API access.

Example

Retrieve a scope:

GET https://<tenant name>.<region>.alm.cloud.sap/api/calm-pm/v1/scopes/{scopeUuid}

Request

Response