Jump to

• Request
• Response

Update CBSDurationSummarys

put

/cbsDurationSummary

Send a request to this endpoint to update one or more cbsDurationSummary. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of cbsDurationSummary objects.

Root Schema : List<CBSDurationSummary>

Type: array

Title: List<CBSDurationSummary>

Show Source

• Array of: object CBSDurationSummary
  Title: CBSDurationSummary

  CBSDurationSummary Entity

{
    "title":"List<CBSDurationSummary>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CBSDurationSummary"
    }
}

Nested Schema : CBSDurationSummary

Type: object

Title: CBSDurationSummary

CBSDurationSummary Entity

Show Source

• CBSObjectId(required): integer (int32)
  The internal CBS ID of the project. This ID cannot be used to load the CBS object directly.
• OriginalProjectObjectId: integer (int32)
  The unique ID of the project from which the project baseline was created, if the current project is a project baseline
• ProjectId(required): string
  The short code of the associated project.
• ProjectName: string
  The name of the associated project.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• SummaryActualDuration: number (double)
  The actual duration.
• SummaryActualFinishDate: string (date-time)
  The latest actual finish date of all activities in the CBS.
• SummaryActualStartDate: string (date-time)
  The earliest actual start date of all activities in the CBS.
• SummaryPercentComplete: number (double)
  The measure that indicates how much of the CBS baseline duration has been completed so far. Computed based on where the current data date falls between the activity's baseline start and finish dates. If the data date is earlier than the baseline start, the schedule % complete is 0. If the data date is later than the baseline finish, the schedule % complete is 100. The schedule % complete indicates how much of the CBS duration should be currently completed, relative to the selected baseline.
• SummaryPlannedDuration: number (double)
  The total working days between planned start and finish dates in the CBS.
• SummaryPlannedFinishDate: string (date-time)
  The latest planned finish date of all activities in the CBS.
• SummaryPlannedStartDate: string (date-time)
  The earliest planned start date of all activities in the CBS.
• SummaryRemainingDuration: number (double)
  The total working time from the CBS remaining start date to the remaining finish date.
• SummaryRemainingFinishDate: string (date-time)
  The date the resource is scheduled to finish the remaining work for the activity.
• SummaryRemainingStartDate: string (date-time)
  The earliest remaining start of all activities assigned to the CBS.

{
    "title":"CBSDurationSummary",
    "required":[
        "CBSObjectId",
        "ProjectId"
    ],
    "type":"object",
    "properties":{
        "CBSObjectId":{
            "type":"integer",
            "description":"The internal CBS ID of the project. This ID cannot be used to load the CBS object directly.",
            "format":"int32"
        },
        "OriginalProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the project from which the project baseline was created, if the current project is a project baseline",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code of the associated project."
        },
        "ProjectName":{
            "type":"string",
            "description":"The name of the associated project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "SummaryActualDuration":{
            "type":"number",
            "description":"The actual duration.",
            "format":"double"
        },
        "SummaryActualFinishDate":{
            "type":"string",
            "description":"The latest actual finish date of all activities in the CBS.",
            "format":"date-time"
        },
        "SummaryActualStartDate":{
            "type":"string",
            "description":"The earliest actual start date of all activities in the CBS.",
            "format":"date-time"
        },
        "SummaryPercentComplete":{
            "type":"number",
            "description":"The measure that indicates how much of the CBS baseline duration has been completed so far. Computed based on where the current data date falls between the activity's baseline start and finish dates. If the data date is earlier than the baseline start, the schedule % complete is 0. If the data date is later than the baseline finish, the schedule % complete is 100. The schedule % complete indicates how much of the CBS duration should be currently completed, relative to the selected baseline.",
            "format":"double"
        },
        "SummaryPlannedDuration":{
            "type":"number",
            "description":"The total working days between planned start and finish dates in the CBS.",
            "format":"double"
        },
        "SummaryPlannedFinishDate":{
            "type":"string",
            "description":"The latest planned finish date of all activities in the CBS.",
            "format":"date-time"
        },
        "SummaryPlannedStartDate":{
            "type":"string",
            "description":"The earliest planned start date of all activities in the CBS.",
            "format":"date-time"
        },
        "SummaryRemainingDuration":{
            "type":"number",
            "description":"The total working time from the CBS remaining start date to the remaining finish date.",
            "format":"double"
        },
        "SummaryRemainingFinishDate":{
            "type":"string",
            "description":"The date the resource is scheduled to finish the remaining work for the activity.",
            "format":"date-time"
        },
        "SummaryRemainingStartDate":{
            "type":"string",
            "description":"The earliest remaining start of all activities assigned to the CBS.",
            "format":"date-time"
        }
    },
    "description":"CBSDurationSummary Entity"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : schema

Type: boolean

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top