Create scenario

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://developers.smartpm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "SmartPM Public API MCP server": {
    "url": "https://developers.smartpm.com/mcp"
  }
}

Close
POST /project/{projectId}/scenario

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required
application/json

Body Required

  • name string Required
  • description string
  • scheduleIds array[integer(int64)] Required
  • ruleIds array[integer(int64)] Required
  • requester string
  • scenarioType string

    Values are COMPLETE or PARTIAL.

  • activityId integer(int64)
  • autoUpdate boolean
  • scenarioConfiguration object
    Hide scenarioConfiguration attribute Show scenarioConfiguration attribute object
    • * string Additional properties
  • modelId integer(int64)
  • contractualEndDates object
    Hide contractualEndDates attribute Show contractualEndDates attribute object
    • * string(date-time) Additional properties
  • requesterCompanyName string
  • aiTenantId string

Responses

  • 200

    OK

POST /project/{projectId}/scenario
curl \
 --request POST 'https://live.smartpmtech.com/project/{projectId}/scenario' \
 --header "X-API-KEY: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-COMPANY-ID: string" \
 --data '{
  "name": "string",
  "description": "string",
  "scheduleIds": [
    42
  ],
  "ruleIds": [
    42
  ],
  "requester": "string",
  "scenarioType": "COMPLETE",
  "activityId": 42,
  "autoUpdate": true,
  "scenarioConfiguration": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "modelId": 42,
  "contractualEndDates": {
    "additionalProperty1": "2026-05-04T09:42:00Z",
    "additionalProperty2": "2026-05-04T09:42:00Z"
  },
  "requesterCompanyName": "string",
  "aiTenantId": "string"
}'
Request examples
# Headers
X-COMPANY-ID: string

# Payload
{
  "name": "string",
  "description": "string",
  "scheduleIds": [
    42
  ],
  "ruleIds": [
    42
  ],
  "requester": "string",
  "scenarioType": "COMPLETE",
  "activityId": 42,
  "autoUpdate": true,
  "scenarioConfiguration": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "modelId": 42,
  "contractualEndDates": {
    "additionalProperty1": "2026-05-04T09:42:00Z",
    "additionalProperty2": "2026-05-04T09:42:00Z"
  },
  "requesterCompanyName": "string",
  "aiTenantId": "string"
}