Jump to

• Request
• Response

ReadCBSResourceSpread

get

/spread/cbsResourceSpread

Reads the summarized CBS spreads of the specified Project Resources

Request

Query Parameters

• BaselineIds(required): string
  BaselineIds's to load

  Example:

  7027,7037

• PeriodType(required): string
  PeriodType to load

  Example:

  WEEK

• ProjectObjectId(required): string
  ProjectObjectId's to load

  Example:

  4835,4845

• SpreadField(required): string
  SpreadField's to load

  Example:

  ActualCost,ActualUnits,AtCompletionCost,AtCompletionUnits,PlannedCost,PlannedUnits,RemainingCost,RemainingUnits

• SummaryDateField(required): string
  SummaryDateField

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<ReadCBSResourceSpreadResponse>

Type: array

Title: List<ReadCBSResourceSpreadResponse>

Show Source

• Array of: object ReadCBSResourceSpreadResponse
  Title: ReadCBSResourceSpreadResponse

  ReadCBSResourceSpreadResponse Entity

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

Nested Schema : ReadCBSResourceSpreadResponse

Type: object

Title: ReadCBSResourceSpreadResponse

ReadCBSResourceSpreadResponse Entity

Show Source

• cbsresourceSpread: array cbsresourceSpread
• CBSResourceSpread: array CBSResourceSpread

{
    "title":"ReadCBSResourceSpreadResponse",
    "type":"object",
    "properties":{
        "cbsresourceSpread":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CBSResourceSpread"
            }
        },
        "CBSResourceSpread":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CBSResourceSpread"
            }
        }
    },
    "description":"ReadCBSResourceSpreadResponse Entity"
}

Nested Schema : cbsresourceSpread

Type: array

Show Source

• Array of: object CBSResourceSpread

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CBSResourceSpread"
    }
}

Nested Schema : CBSResourceSpread

Type: array

Show Source

• Array of: object CBSResourceSpread

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CBSResourceSpread"
    }
}

Nested Schema : CBSResourceSpread

Type: object

Show Source

• BaselineProjectObjectId: integer (int32)
• BaselineType: string
• cbsobjectId: integer (int32)
• CBSObjectId: integer (int32)
• CurrencyId: string
• CurrencyName: string
• DataDate: string
• EndDate: string (date-time)
• OriginalProjectObjectId: integer (int32)
• Period: array Period
• PeriodType: string
• ProjectId: string
• ProjectName: string
• ProjectObjectId: integer (int32)
• ResourceId: string
• ResourceName: string
• ResourceObjectId: integer (int32)
• ResourceType: string
• StartDate: string (date-time)
• SummaryActualCost: number (double)
• SummaryActualFinish: string (date-time)
• SummaryActualStart: string (date-time)
• SummaryActualUnits: number (double)
• SummaryAtCompletionCost: number (double)
• SummaryAtCompletionUnits: number (double)
• SummaryPlannedCost: number (double)
• SummaryPlannedFinish: string (date-time)
• SummaryPlannedStart: string (date-time)
• SummaryPlannedUnits: number (double)
• SummaryRemainingCost: number (double)
• SummaryRemainingFinish: string (date-time)
• SummaryRemainingStart: string (date-time)
• SummaryRemainingUnits: number (double)
• UnitAbbreviation: string
• UnitName: string

{
    "type":"object",
    "properties":{
        "cbsobjectId":{
            "type":"integer",
            "format":"int32"
        },
        "BaselineProjectObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "ProjectObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string"
        },
        "ProjectName":{
            "type":"string"
        },
        "OriginalProjectObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "CBSObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "ResourceObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "BaselineType":{
            "type":"string"
        },
        "DataDate":{
            "type":"string"
        },
        "ResourceId":{
            "type":"string"
        },
        "ResourceName":{
            "type":"string"
        },
        "ResourceType":{
            "type":"string"
        },
        "UnitName":{
            "type":"string"
        },
        "UnitAbbreviation":{
            "type":"string"
        },
        "CurrencyId":{
            "type":"string"
        },
        "CurrencyName":{
            "type":"string"
        },
        "SummaryActualCost":{
            "type":"number",
            "format":"double"
        },
        "SummaryActualUnits":{
            "type":"number",
            "format":"double"
        },
        "SummaryAtCompletionCost":{
            "type":"number",
            "format":"double"
        },
        "SummaryAtCompletionUnits":{
            "type":"number",
            "format":"double"
        },
        "SummaryPlannedCost":{
            "type":"number",
            "format":"double"
        },
        "SummaryPlannedUnits":{
            "type":"number",
            "format":"double"
        },
        "SummaryRemainingCost":{
            "type":"number",
            "format":"double"
        },
        "SummaryRemainingUnits":{
            "type":"number",
            "format":"double"
        },
        "SummaryActualFinish":{
            "type":"string",
            "format":"date-time"
        },
        "SummaryActualStart":{
            "type":"string",
            "format":"date-time"
        },
        "SummaryPlannedFinish":{
            "type":"string",
            "format":"date-time"
        },
        "SummaryPlannedStart":{
            "type":"string",
            "format":"date-time"
        },
        "SummaryRemainingFinish":{
            "type":"string",
            "format":"date-time"
        },
        "SummaryRemainingStart":{
            "type":"string",
            "format":"date-time"
        },
        "StartDate":{
            "type":"string",
            "format":"date-time"
        },
        "EndDate":{
            "type":"string",
            "format":"date-time"
        },
        "PeriodType":{
            "type":"string"
        },
        "Period":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CBSRsrcExpenseSpreadPeriod"
            }
        }
    }
}

Nested Schema : Period

Type: array

Show Source

• Array of: object CBSRsrcExpenseSpreadPeriod

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CBSRsrcExpenseSpreadPeriod"
    }
}

Nested Schema : CBSRsrcExpenseSpreadPeriod

Type: object

Show Source

• ActualCost: number (double)
• ActualUnits: number (double)
• AtCompletionCost: number (double)
• AtCompletionUnits: number (double)
• EndDate: string
• PlannedCost: number (double)
• PlannedUnits: number (double)
• RemainingCost: number (double)
• RemainingUnits: number (double)
• StartDate: string

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string"
        },
        "EndDate":{
            "type":"string"
        },
        "ActualCost":{
            "type":"number",
            "format":"double"
        },
        "ActualUnits":{
            "type":"number",
            "format":"double"
        },
        "AtCompletionCost":{
            "type":"number",
            "format":"double"
        },
        "AtCompletionUnits":{
            "type":"number",
            "format":"double"
        },
        "PlannedCost":{
            "type":"number",
            "format":"double"
        },
        "PlannedUnits":{
            "type":"number",
            "format":"double"
        },
        "RemainingCost":{
            "type":"number",
            "format":"double"
        },
        "RemainingUnits":{
            "type":"number",
            "format":"double"
        }
    }
}

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