Get Activities (v2)

GET /public/v2/projects/{projectId}/scenarios/{scenarioId}/activities

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required
  • scenarioId integer(int64) Required

Query parameters

  • dataDate string
  • filterId array[integer(int64)]
  • activityCodeFilter array[integer(int64)]
  • includeDeleted boolean

Responses

  • 500 */*

    Internal Server Error

  • 200 */*

    OK

    Hide response attributes Show response attributes object

    Activity Response V2

    • id integer(int64) Required

      Activity ID

    • activityId string Required

      Custom Activity ID

    • name string Required

      Activity Name

    • percentCompleteType string Required

      Percent Complete Type

      Values are DURATION, PHYSICAL, or UNITS.

    • durationPercentComplete number(double) Required

      Duration Percent Complete

    • physicalPercentComplete number(double) Required

      Physical Percent Complete

    • unitsPercentComplete number(double) Required

      Units Percent Complete

    • floatTotal number(double) Required

      Total Float

    • nativeFloatTotal number(double) Required

      Native Total Float

    • floatFree number(double) Required

      Free Float

    • activityType string Required

      Activity Type

      Values are TaskDependent, Task, StartMilestone, FinishMilestone, or LevelOfEffort.

    • constraintType string Required

      Constraint Type

      Values are AsLateAsPossible, FinishOn, FinishOnOrAfter, FinishOnOrBefore, MandatoryFinish, MandatoryStart, StartOn, StartOnOrAfter, StartOnOrBefore, ExternalStart, or Resume.

    • externalId string Required

      External ID

    • wbsId integer(int32) Required

      WBS ID

    • calendarId integer(int64) Required

      Calendar ID

    • plannedDuration number(double) Required

      Planned Duration

    • remainingDuration number(double) Required

      Remaining Duration

    • rolledBackRemainingDuration number(double) Required

      Rolled Back Remaining Duration

    • actualDuration number(double) Required

      Actual Duration

    • plannedBudget number(double) Required

      Planned Budget

    • plannedManpower number(double) Required

      Planned Manpower

    • durationVariance number(double) Required

      Duration Variance

    • baseline object Required

      Activity Baseline Response

      Hide baseline attributes Show baseline attributes object
      • startDate string(date-time) Required

        Start Date

      • finishDate string(date-time) Required

        Finish Date

      • duration number(double) Required

        Duration

      • critical boolean Required

        Is Critical

      • type string Required

        Activity Baseline Type

        Values are Global or Isolated.

    • drivers array[integer(int64)] Required

      Driver Activity IDs

    • driving array[integer(int64)] Required

      Driving Activity IDs

    • inLongestPath boolean Required

      In Longest Path

    • retainLogic boolean Required

      Retain Logic

    • deleted boolean Required

      Deleted

    • startDate Required

      Start Date

    • finishDate Required

      Finish Date

    • lateStartDate Required

      Late Start Date

    • lateFinishDate Required

      Late Finish Date

    • actualStartDate Required

      Actual Start Date

    • actualFinishDate Required

      Actual Finish Date

    • constrainedDate Required

      Constrained Date

    • resumeDate Required

      Resume Date

    • sourceStartDate Required

      Source Start Date

    • sourceFinishDate Required

      Source Finish Date

    • sourceActualStartDate Required

      Source Actual Start Date

    • sourceActualFinishDate Required

      Source Actual Finish Date

    • workDayDataDate Required

      Work Day Data Date

    • percentComplete number(double)
    • activityCodes array[object] Required

      Activity Codes, to get options for the possible values see Get Activity Codes for Project

      Activity Code Response

      Hide activityCodes attributes Show activityCodes attributes object
      • activityCodeTypeId integer(int64) Required

        Activity Code Type ID

      • activityCodeId integer(int64) Required

        Activity Code ID

GET /public/v2/projects/{projectId}/scenarios/{scenarioId}/activities
curl \
 --request GET 'https://live.smartpmtech.com/public/v2/projects/{projectId}/scenarios/{scenarioId}/activities' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"
Response examples (500)
{}
Response examples (200)
[
  {
    "id": 1001,
    "activityId": "A-1001",
    "name": "Foundation Work",
    "percentCompleteType": "DURATION",
    "durationPercentComplete": 50.0,
    "physicalPercentComplete": 60.0,
    "unitsPercentComplete": 70.0,
    "floatTotal": 10.0,
    "nativeFloatTotal": 8.0,
    "floatFree": 5.0,
    "activityType": "Task",
    "constraintType": "FinishOn",
    "externalId": "EXT-12345",
    "wbsId": 10,
    "calendarId": 3,
    "plannedDuration": 15.0,
    "remainingDuration": 7.0,
    "rolledBackRemainingDuration": 9.0,
    "actualDuration": 8.0,
    "plannedBudget": 5000.0,
    "plannedManpower": 120.0,
    "durationVariance": 2.0,
    "baseline": {
      "startDate": "2023-01-01T08:00:00+00:00",
      "finishDate": "2023-01-10T17:00:00+00:00",
      "duration": 8.0,
      "critical": true,
      "type": "Global"
    },
    "drivers": [
      100,
      101
    ],
    "driving": [
      200,
      201
    ],
    "inLongestPath": true,
    "retainLogic": false,
    "deleted": false,
    "startDate": "2024-01-01T08:00:00+00:00",
    "finishDate": "2024-01-10T17:00:00+00:00",
    "lateStartDate": "2024-01-02T08:00:00+00:00",
    "lateFinishDate": "2024-01-11T17:00:00+00:00",
    "actualStartDate": "2024-01-01T09:00:00+00:00",
    "actualFinishDate": "2024-01-09T16:00:00+00:00",
    "constrainedDate": "2024-01-05T00:00:00+00:00",
    "resumeDate": "2024-01-03T08:00:00+00:00",
    "sourceStartDate": "2023-12-30T08:00:00+00:00",
    "sourceFinishDate": "2024-01-08T17:00:00+00:00",
    "sourceActualStartDate": "2024-01-01T10:00:00+00:00",
    "sourceActualFinishDate": "2024-01-09T15:00:00+00:00",
    "workDayDataDate": "2024-01-04T00:00:00+00:00",
    "percentComplete": 42.0,
    "activityCodes": [
      {
        "activityCodeTypeId": 1,
        "activityCodeId": 10
      }
    ]
  }
]