Jump to

• Request
• Response

Download Activity/Assignment Spread

get

/api/restapi/action/spreadResult/{jobId}

Send a request to this endpoint to download the activity or assignment spread file once the Calculate Activity/Assignment Spread job has completed. Track the status of the Calculate Activity/Assignment Spread job using the View Job Status endpoint.

Request

Path Parameters

• jobId(required): integer(int64)
  The jobId field value returned as part of the Calculate Activity/Assignment Spread endpoint response.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/octet-stream

200 Response

The response returned by the Download Activity/Assignment Spread endpoint is available as a zip file. Unzip the file to retrieve the JSON file inside the zip file.

Body ()

Root Schema : ApiEntitySpreadOutput

Type: object

Title: ApiEntitySpreadOutput

Show Source

• activities: array activities
  The aggregate that contains the list of activities used in the spread calculation. It is applicable when downloading the spread output for Calculate Activity Spread jobs.
• project: project
  The aggregate that contains key information about the project used in the spread calculation.
• resourceAssignments: array resourceAssignments
  The aggregate that contains the list of resource assignments used in the spread calculation. It is applicable when downloading the spread output for Calculate Assignment Spread jobs.
• timescale: string
  Allowed Values: [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY" ]

  Timescale for the spread calculation. If not provided, Daily will be used.

{
    "title":"ApiEntitySpreadOutput",
    "type":"object",
    "properties":{
        "project":{
            "description":"The aggregate that contains key information about the project used in the spread calculation.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntitySpreadOutputProject"
                }
            ]
        },
        "activities":{
            "type":"array",
            "description":"The aggregate that contains the list of activities used in the spread calculation. It is applicable when downloading the spread output for Calculate Activity Spread jobs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySpreadOutputActivity",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "resourceAssignments":{
            "type":"array",
            "description":"The aggregate that contains the list of resource assignments used in the spread calculation. It is applicable when downloading the spread output for Calculate Assignment Spread jobs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySpreadOutputAssignment",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "timescale":{
            "type":"string",
            "description":"Timescale for the spread calculation. If not provided, Daily will be used.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DAILY",
                "WEEKLY",
                "MONTHLY",
                "QUARTERLY"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : activities

Type: array

The aggregate that contains the list of activities used in the spread calculation. It is applicable when downloading the spread output for Calculate Activity Spread jobs.

Show Source

• Array of: object ApiEntitySpreadOutputActivity
  Title: ApiEntitySpreadOutputActivity

{
    "type":"array",
    "description":"The aggregate that contains the list of activities used in the spread calculation. It is applicable when downloading the spread output for Calculate Activity Spread jobs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySpreadOutputActivity",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : project

The aggregate that contains key information about the project used in the spread calculation.

Match All

Show Source

• object ApiEntitySpreadOutputProject
  Title: ApiEntitySpreadOutputProject

{
    "description":"The aggregate that contains key information about the project used in the spread calculation.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntitySpreadOutputProject"
        }
    ]
}

Nested Schema : resourceAssignments

Type: array

The aggregate that contains the list of resource assignments used in the spread calculation. It is applicable when downloading the spread output for Calculate Assignment Spread jobs.

Show Source

• Array of: object ApiEntitySpreadOutputAssignment
  Title: ApiEntitySpreadOutputAssignment

{
    "type":"array",
    "description":"The aggregate that contains the list of resource assignments used in the spread calculation. It is applicable when downloading the spread output for Calculate Assignment Spread jobs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySpreadOutputAssignment",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntitySpreadOutputActivity

Type: object

Title: ApiEntitySpreadOutputActivity

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier for the activity.
• activityName: string
  Maximum Length: 255

  The name of the activity.
• actualTotalCost: number (double)
  The actual total cost for all resource assignments and direct activity costs (expenses) on the activity.
• actualTotalCostProject: number (double)
  The actual total cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.
• atCompletionTotalCost: number (double)
  The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from atCompletionTotalCostProject field based on the specified exchange rate.
• atCompletionTotalCostProject: number (double)
  The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs on the activity. This value is based on the project currency.
• earnedValueCost: number (double)
  The portion of the baseline total cost of the activity that is actually completed as of the project data date. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.
• earnedValueCostProject: number (double)
  The approved budget for work actually completed by the specified project data date.
  Calculated as Budget At Completion multiplied by Performance Percent Complete. The method for computing performance percent complete depends on the Earned Value technique defined in the project settings. This value is based on the project currency.
• estimateAtCompletionCost: number (double)
  Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateAtCompletionCostProject field based on the specified exchange rate.
• estimateAtCompletionCostProject: number (double)
  The forecasted cost of the project as the project progresses. This value is based on the project currency.
• estimateToCompleteCost: number (double)
  Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateToCompletionCostProject field based on the specified exchange rate.
• estimateToCompleteCostProject: number (double)
  The estimated cost to complete the activity. This value is based on the project currency.
• estimateToCompleteLaborUnits: integer (int64)
  The estimated number of labor units required to complete the activity.
  Calculated as the Remaining Total Units for the activity.
• plannedTotalCost: number (double)
  The expected total cost of the activity and includes all resources and direct activity costs (expenses). This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.
• plannedTotalCostProject: number (double)
  The expected total cost of the activity, including all resource assignments and direct activity costs. This value is based on the project currency.
• plannedValueCost: number (double)
  The portion of the baseline total cost of the activity that is scheduled to be completed as of the project data date. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.
• plannedValueCostProject: number (double)
  The approved budget for the work scheduled to be completed by a specified date.
  Calculated as Budget At Completion multiplied by Schedule Percent Complete.
  When an activity has assignments, the Planned Value Cost is calculated as Budget At Completion multiplied by (Data Date of Current Project - Baseline Assignment Start Date) divided by (Baseline Assignment Finish Date - Baseline Assignment Start Date). Each assignment is then summed to the activity-level planned value. This value is based on the project currency.
• remainingTotalCost: number (double)
  The remaining cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingTotalCostProject field based on the specified exchange rate.
• remainingTotalCostProject: number (double)
  The remaining cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.
• spread: spread
  The aggregate that contains the lists of spread dates and spread values for the activity spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate is applicable when downloading the spread output for Calculate Activity Spread jobs.
• wbsId: integer (int64)
  The WBS that the activity is associated with.

{
    "title":"ApiEntitySpreadOutputActivity",
    "type":"object",
    "properties":{
        "activityName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"The WBS that the activity is associated with.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedValueCost":{
            "type":"number",
            "description":"The portion of the baseline total cost of the activity that is scheduled to be completed as of the project data date. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedValueCost":{
            "type":"number",
            "description":"The portion of the baseline total cost of the activity that is actually completed as of the project data date. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualTotalCost":{
            "type":"number",
            "description":"The actual total cost for all resource assignments and direct activity costs (expenses) on the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estimateAtCompletionCost":{
            "type":"number",
            "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateAtCompletionCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingTotalCost":{
            "type":"number",
            "description":"The remaining cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingTotalCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionTotalCost":{
            "type":"number",
            "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from atCompletionTotalCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedTotalCost":{
            "type":"number",
            "description":"The expected total cost of the activity and includes all resources and direct activity costs (expenses). This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualTotalCostProject":{
            "type":"number",
            "description":"The actual total cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.   ",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionTotalCostProject":{
            "type":"number",
            "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs on the activity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedTotalCostProject":{
            "type":"number",
            "description":"The expected total cost of the activity, including all resource assignments and direct activity costs. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingTotalCostProject":{
            "type":"number",
            "description":"The remaining cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedValueCostProject":{
            "type":"number",
            "description":"The approved budget for work actually completed by the specified project data date. <br />Calculated as Budget At Completion multiplied by Performance Percent Complete. The method for computing performance percent complete depends on the Earned Value technique defined in the project settings. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estimateAtCompletionCostProject":{
            "type":"number",
            "description":"The forecasted cost of the project as the project progresses. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCostProject":{
            "type":"number",
            "description":"The approved budget for the work scheduled to be completed by a specified date. <br />Calculated as Budget At Completion multiplied by Schedule Percent Complete. <br />When an activity has assignments, the Planned Value Cost is calculated as Budget At Completion multiplied by (Data Date of Current Project - Baseline Assignment Start Date) divided by (Baseline Assignment Finish Date - Baseline Assignment Start Date). Each assignment is then summed to the activity-level planned value. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "estimateToCompleteLaborUnits":{
            "type":"integer",
            "description":"The estimated number of labor units required to complete the activity. <br />Calculated as the Remaining Total Units for the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "estimateToCompleteCost":{
            "type":"number",
            "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateToCompletionCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estimateToCompleteCostProject":{
            "type":"number",
            "description":"The estimated cost to complete the activity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spread":{
            "description":"The aggregate that contains the lists of spread dates and spread values for the activity spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate is applicable when downloading the spread output for Calculate Activity Spread jobs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntitySpreadOutputActivitySpread"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : spread

The aggregate that contains the lists of spread dates and spread values for the activity spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate is applicable when downloading the spread output for Calculate Activity Spread jobs.

Match All

Show Source

• object ApiEntitySpreadOutputActivitySpread
  Title: ApiEntitySpreadOutputActivitySpread

{
    "description":"The aggregate that contains the lists of spread dates and spread values for the activity spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate is applicable when downloading the spread output for Calculate Activity Spread jobs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntitySpreadOutputActivitySpread"
        }
    ]
}

Nested Schema : ApiEntitySpreadOutputActivitySpread

Type: object

Title: ApiEntitySpreadOutputActivitySpread

Show Source

• actualTotalCost: array actualTotalCost
  The actual total cost for all resource assignments and direct activity costs (expenses) on the activity.
• actualTotalCostProject: array actualTotalCostProject
  The actual total cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.
• atCompletionTotalCost: array atCompletionTotalCost
  The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from atCompletionTotalCostProject field based on the specified exchange rate.
• atCompletionTotalCostProject: array atCompletionTotalCostProject
  The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs on the activity. This value is based on the project currency.
• earnedValueCost: array earnedValueCost
  The portion of the baseline total cost of the activity that is actually completed as of the project data date. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.
• earnedValueCostProject: array earnedValueCostProject
  The approved budget for work actually completed by the specified project data date.
  Calculated as Budget At Completion multiplied by Performance Percent Complete. The method for computing performance percent complete depends on the Earned Value technique defined in the project settings. This value is based on the project currency.
• estimateAtCompletionCost: array estimateAtCompletionCost
  Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateAtCompletionCostProject field based on the specified exchange rate.
• estimateAtCompletionCostProject: array estimateAtCompletionCostProject
  The forecasted cost of the project as the project progresses. This value is based on the project currency.
• estimateToCompleteCost: array estimateToCompleteCost
  Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateToCompletionCostProject field based on the specified exchange rate.
• estimateToCompleteCostProject: array estimateToCompleteCostProject
  The estimated cost to complete the activity. This value is based on the project currency.
• estimateToCompleteLaborUnits: array estimateToCompleteLaborUnits
  The estimated number of labor units required to complete the activity.
  Calculated as the Remaining Total Units for the activity.
• plannedTotalCost: array plannedTotalCost
  The expected total cost of the activity and includes all resources and direct activity costs (expenses). This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.
• plannedTotalCostProject: array plannedTotalCostProject
  The expected total cost of the activity, including all resource assignments and direct activity costs. This value is based on the project currency.
• plannedValueCost: array plannedValueCost
  The portion of the baseline total cost of the activity that is scheduled to be completed as of the project data date. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.
• plannedValueCostProject: array plannedValueCostProject
  The approved budget for the work scheduled to be completed by a specified date.
  Calculated as Budget At Completion multiplied by Schedule Percent Complete.
  When an activity has assignments, the Planned Value Cost is calculated as Budget At Completion multiplied by (Data Date of Current Project - Baseline Assignment Start Date) divided by (Baseline Assignment Finish Date - Baseline Assignment Start Date). Each assignment is then summed to the activity-level planned value. This value is based on the project currency.
• remainingTotalCost: array remainingTotalCost
  The remaining cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingTotalCostProject field based on the specified exchange rate.
• remainingTotalCostProject: array remainingTotalCostProject
  The remaining cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.
• spreadDates: array spreadDates
  The list of spread dates derived according to the timescale for all the spread items in the request.

{
    "title":"ApiEntitySpreadOutputActivitySpread",
    "type":"object",
    "properties":{
        "plannedValueCost":{
            "type":"array",
            "description":"The portion of the baseline total cost of the activity that is scheduled to be completed as of the project data date. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "earnedValueCost":{
            "type":"array",
            "description":"The portion of the baseline total cost of the activity that is actually completed as of the project data date. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "actualTotalCost":{
            "type":"array",
            "description":"The actual total cost for all resource assignments and direct activity costs (expenses) on the activity.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "estimateAtCompletionCost":{
            "type":"array",
            "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateAtCompletionCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "remainingTotalCost":{
            "type":"array",
            "description":"The remaining cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingTotalCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "atCompletionTotalCost":{
            "type":"array",
            "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from atCompletionTotalCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "plannedTotalCost":{
            "type":"array",
            "description":"The expected total cost of the activity and includes all resources and direct activity costs (expenses). This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "actualTotalCostProject":{
            "type":"array",
            "description":"The actual total cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.   ",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "atCompletionTotalCostProject":{
            "type":"array",
            "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs on the activity. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "plannedTotalCostProject":{
            "type":"array",
            "description":"The expected total cost of the activity, including all resource assignments and direct activity costs. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "remainingTotalCostProject":{
            "type":"array",
            "description":"The remaining cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "earnedValueCostProject":{
            "type":"array",
            "description":"The approved budget for work actually completed by the specified project data date. <br />Calculated as Budget At Completion multiplied by Performance Percent Complete. The method for computing performance percent complete depends on the Earned Value technique defined in the project settings. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "estimateAtCompletionCostProject":{
            "type":"array",
            "description":"The forecasted cost of the project as the project progresses. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "plannedValueCostProject":{
            "type":"array",
            "description":"The approved budget for the work scheduled to be completed by a specified date. <br />Calculated as Budget At Completion multiplied by Schedule Percent Complete. <br />When an activity has assignments, the Planned Value Cost is calculated as Budget At Completion multiplied by (Data Date of Current Project - Baseline Assignment Start Date) divided by (Baseline Assignment Finish Date - Baseline Assignment Start Date). Each assignment is then summed to the activity-level planned value. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "estimateToCompleteLaborUnits":{
            "type":"array",
            "description":"The estimated number of labor units required to complete the activity. <br />Calculated as the Remaining Total Units for the activity.",
            "exampleSetFlag":false,
            "items":{
                "type":"integer",
                "format":"int64",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "estimateToCompleteCost":{
            "type":"array",
            "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateToCompletionCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "estimateToCompleteCostProject":{
            "type":"array",
            "description":"The estimated cost to complete the activity. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "spreadDates":{
            "type":"array",
            "description":"The list of spread dates derived according to the timescale for all the spread items in the request.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "format":"date-time",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : actualTotalCost

Type: array

The actual total cost for all resource assignments and direct activity costs (expenses) on the activity.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The actual total cost for all resource assignments and direct activity costs (expenses) on the activity.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : actualTotalCostProject

Type: array

The actual total cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The actual total cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.   ",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : atCompletionTotalCost

Type: array

The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from atCompletionTotalCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from atCompletionTotalCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : atCompletionTotalCostProject

Type: array

The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs on the activity. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs on the activity. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : earnedValueCost

Type: array

The portion of the baseline total cost of the activity that is actually completed as of the project data date. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The portion of the baseline total cost of the activity that is actually completed as of the project data date. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : earnedValueCostProject

Type: array

The approved budget for work actually completed by the specified project data date.
Calculated as Budget At Completion multiplied by Performance Percent Complete. The method for computing performance percent complete depends on the Earned Value technique defined in the project settings. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The approved budget for work actually completed by the specified project data date. <br />Calculated as Budget At Completion multiplied by Performance Percent Complete. The method for computing performance percent complete depends on the Earned Value technique defined in the project settings. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : estimateAtCompletionCost

Type: array

Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateAtCompletionCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateAtCompletionCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : estimateAtCompletionCostProject

Type: array

The forecasted cost of the project as the project progresses. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The forecasted cost of the project as the project progresses. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : estimateToCompleteCost

Type: array

Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateToCompletionCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateToCompletionCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : estimateToCompleteCostProject

Type: array

The estimated cost to complete the activity. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The estimated cost to complete the activity. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : estimateToCompleteLaborUnits

Type: array

The estimated number of labor units required to complete the activity.
Calculated as the Remaining Total Units for the activity.

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "description":"The estimated number of labor units required to complete the activity. <br />Calculated as the Remaining Total Units for the activity.",
    "exampleSetFlag":false,
    "items":{
        "type":"integer",
        "format":"int64",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : plannedTotalCost

Type: array

The expected total cost of the activity and includes all resources and direct activity costs (expenses). This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The expected total cost of the activity and includes all resources and direct activity costs (expenses). This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : plannedTotalCostProject

Type: array

The expected total cost of the activity, including all resource assignments and direct activity costs. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The expected total cost of the activity, including all resource assignments and direct activity costs. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : plannedValueCost

Type: array

The portion of the baseline total cost of the activity that is scheduled to be completed as of the project data date. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The portion of the baseline total cost of the activity that is scheduled to be completed as of the project data date. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : plannedValueCostProject

Type: array

The approved budget for the work scheduled to be completed by a specified date.
Calculated as Budget At Completion multiplied by Schedule Percent Complete.
When an activity has assignments, the Planned Value Cost is calculated as Budget At Completion multiplied by (Data Date of Current Project - Baseline Assignment Start Date) divided by (Baseline Assignment Finish Date - Baseline Assignment Start Date). Each assignment is then summed to the activity-level planned value. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The approved budget for the work scheduled to be completed by a specified date. <br />Calculated as Budget At Completion multiplied by Schedule Percent Complete. <br />When an activity has assignments, the Planned Value Cost is calculated as Budget At Completion multiplied by (Data Date of Current Project - Baseline Assignment Start Date) divided by (Baseline Assignment Finish Date - Baseline Assignment Start Date). Each assignment is then summed to the activity-level planned value. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : remainingTotalCost

Type: array

The remaining cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingTotalCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The remaining cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingTotalCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : remainingTotalCostProject

Type: array

The remaining cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The remaining cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : spreadDates

Type: array

The list of spread dates derived according to the timescale for all the spread items in the request.

Show Source

• Array of: string(date-time)

{
    "type":"array",
    "description":"The list of spread dates derived according to the timescale for all the spread items in the request.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "format":"date-time",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntitySpreadOutputProject

Type: object

Title: ApiEntitySpreadOutputProject

Show Source

• baselineId: integer (int64)
  The system-generated identifier of a baseline.
• baselineName: string
  Maximum Length: 255

  Name for the baseline or snapshot.
• isBaseline: boolean
  Indicates whether or not the spread calculation is for Earned Value baseline.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectName: string
  Maximum Length: 255

  The name of the project.

{
    "title":"ApiEntitySpreadOutputProject",
    "type":"object",
    "properties":{
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineId":{
            "type":"integer",
            "description":"The system-generated identifier of a baseline.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "baselineName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isBaseline":{
            "type":"boolean",
            "description":"Indicates whether or not the spread calculation is for Earned Value baseline.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntitySpreadOutputAssignment

Type: object

Title: ApiEntitySpreadOutputAssignment

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier for the activity.
• activityName: string
  Maximum Length: 255

  The name of the activity.
• actualCost: number (double)
  The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.
• actualCostProject: number (double)
  The actual cost for the resource assignment on the activity. This value is based on the project currency.
• actualUnits: integer (int64)
  The sum of the actual non-overtime and the overtime units worked by the resource on the activity.
• assignmentCode: string
  Maximum Length: 60

  A unique identifier for the assignment.
• assignmentId: integer (int64)
  The system-generated identifier of an assignment.
• atCompletionCost: number (double)
  The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.
• atCompletionCostProject: number (double)
  The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.
• atCompletionUnits: integer (int64)
  The sum of the actual units and remaining units for the resource assignment on the activity.
  Calculated as Actual Units plus Remaining Units.
• plannedCost: number (double)
  The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.
• plannedCostProject: number (double)
  The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.
• plannedUnits: integer (int64)
  The planned units of work for the resource assignment on the activity.
• rateSource: string
  Allowed Values: [ "RESOURCE", "ROLE", "OVERRIDE" ]

  The value that indicates which Price/Unit will be used to calculate costs for the assignment. Valid options are Resource, Role, or Override.
• remainingCost: number (double)
  The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.
• remainingCostProject: number (double)
  The remaining cost for the resource assignment on the activity. This value is based on the project currency.
• remainingUnits: integer (int64)
  The remaining units of work to be performed by the resource on the activity.
• resourceCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• resourceName: string
  Maximum Length: 255

  The name of the resource or role.
• roleCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• roleId: integer (int64)
  The unique identifier for the resource or role.
• roleName: string
  Maximum Length: 255

  The name of the resource or role.
• spread: spread
  The aggregate that contains the lists of spread dates and spread values for the assignment spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate applicable when downloading the spread output for Calculate Assignment Spread jobs.

{
    "title":"ApiEntitySpreadOutputAssignment",
    "type":"object",
    "properties":{
        "activityName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of an assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentCode":{
            "maxLength":"60",
            "type":"string",
            "description":"A unique identifier for the assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualUnits":{
            "type":"integer",
            "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "plannedUnits":{
            "type":"integer",
            "description":"The planned units of work for the resource assignment on the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "atCompletionUnits":{
            "type":"integer",
            "description":"The sum of the actual units and remaining units for the resource assignment on the activity. <br />Calculated as Actual Units plus Remaining Units.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "remainingUnits":{
            "type":"integer",
            "description":"The remaining units of work to be performed by the resource on the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "resourceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingCost":{
            "type":"number",
            "description":"The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCost":{
            "type":"number",
            "description":"The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedCost":{
            "type":"number",
            "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionCost":{
            "type":"number",
            "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostProject":{
            "type":"number",
            "description":"The actual cost for the resource assignment on the activity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionCostProject":{
            "type":"number",
            "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedCostProject":{
            "type":"number",
            "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingCostProject":{
            "type":"number",
            "description":"The remaining cost for the resource assignment on the activity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "resourceName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "roleId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "roleCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "roleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spread":{
            "description":"The aggregate that contains the lists of spread dates and spread values for the assignment spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate applicable when downloading the spread output for Calculate Assignment Spread jobs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntitySpreadOutputAssignmentSpread"
                }
            ]
        },
        "rateSource":{
            "type":"string",
            "description":"The value that indicates which Price/Unit will be used to calculate costs for the assignment. Valid options are Resource, Role, or Override.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE",
                "OVERRIDE"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : spread

The aggregate that contains the lists of spread dates and spread values for the assignment spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate applicable when downloading the spread output for Calculate Assignment Spread jobs.

Match All

Show Source

• object ApiEntitySpreadOutputAssignmentSpread
  Title: ApiEntitySpreadOutputAssignmentSpread

{
    "description":"The aggregate that contains the lists of spread dates and spread values for the assignment spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate applicable when downloading the spread output for Calculate Assignment Spread jobs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntitySpreadOutputAssignmentSpread"
        }
    ]
}

Nested Schema : ApiEntitySpreadOutputAssignmentSpread

Type: object

Title: ApiEntitySpreadOutputAssignmentSpread

Show Source

• actualCost: array actualCost
  The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.
• actualCostProject: array actualCostProject
  The actual cost for the resource assignment on the activity. This value is based on the project currency.
• actualUnits: array actualUnits
  The sum of the actual non-overtime and the overtime units worked by the resource on the activity.
• atCompletionCost: array atCompletionCost
  The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.
• atCompletionCostProject: array atCompletionCostProject
  The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.
• atCompletionUnits: array atCompletionUnits
  The sum of the actual units and remaining units for the resource assignment on the activity.
  Calculated as Actual Units plus Remaining Units.
• plannedCost: array plannedCost
  The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.
• plannedCostProject: array plannedCostProject
  The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.
• plannedUnits: array plannedUnits
  The planned units of work for the resource assignment on the activity.
• remainingCost: array remainingCost
  The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.
• remainingCostProject: array remainingCostProject
  The remaining cost for the resource assignment on the activity. This value is based on the project currency.
• remainingUnits: array remainingUnits
  The remaining units of work to be performed by the resource on the activity.
• spreadDates: array spreadDates
  The list of spread dates derived according to the timescale for all the spread items in the request.

{
    "title":"ApiEntitySpreadOutputAssignmentSpread",
    "type":"object",
    "properties":{
        "actualUnits":{
            "type":"array",
            "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.",
            "exampleSetFlag":false,
            "items":{
                "type":"integer",
                "format":"int64",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "plannedUnits":{
            "type":"array",
            "description":"The planned units of work for the resource assignment on the activity.",
            "exampleSetFlag":false,
            "items":{
                "type":"integer",
                "format":"int64",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "atCompletionUnits":{
            "type":"array",
            "description":"The sum of the actual units and remaining units for the resource assignment on the activity. <br />Calculated as Actual Units plus Remaining Units.",
            "exampleSetFlag":false,
            "items":{
                "type":"integer",
                "format":"int64",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "remainingUnits":{
            "type":"array",
            "description":"The remaining units of work to be performed by the resource on the activity.",
            "exampleSetFlag":false,
            "items":{
                "type":"integer",
                "format":"int64",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "remainingCost":{
            "type":"array",
            "description":"The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "actualCost":{
            "type":"array",
            "description":"The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "plannedCost":{
            "type":"array",
            "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "atCompletionCost":{
            "type":"array",
            "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "actualCostProject":{
            "type":"array",
            "description":"The actual cost for the resource assignment on the activity. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "atCompletionCostProject":{
            "type":"array",
            "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "plannedCostProject":{
            "type":"array",
            "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "remainingCostProject":{
            "type":"array",
            "description":"The remaining cost for the resource assignment on the activity. This value is based on the project currency.",
            "exampleSetFlag":false,
            "items":{
                "type":"number",
                "format":"double",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "spreadDates":{
            "type":"array",
            "description":"The list of spread dates derived according to the timescale for all the spread items in the request.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "format":"date-time",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : actualCost

Type: array

The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : actualCostProject

Type: array

The actual cost for the resource assignment on the activity. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The actual cost for the resource assignment on the activity. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : actualUnits

Type: array

The sum of the actual non-overtime and the overtime units worked by the resource on the activity.

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.",
    "exampleSetFlag":false,
    "items":{
        "type":"integer",
        "format":"int64",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : atCompletionCost

Type: array

The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : atCompletionCostProject

Type: array

The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : atCompletionUnits

Type: array

The sum of the actual units and remaining units for the resource assignment on the activity.
Calculated as Actual Units plus Remaining Units.

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "description":"The sum of the actual units and remaining units for the resource assignment on the activity. <br />Calculated as Actual Units plus Remaining Units.",
    "exampleSetFlag":false,
    "items":{
        "type":"integer",
        "format":"int64",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : plannedCost

Type: array

The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : plannedCostProject

Type: array

The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : plannedUnits

Type: array

The planned units of work for the resource assignment on the activity.

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "description":"The planned units of work for the resource assignment on the activity.",
    "exampleSetFlag":false,
    "items":{
        "type":"integer",
        "format":"int64",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : remainingCost

Type: array

The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : remainingCostProject

Type: array

The remaining cost for the resource assignment on the activity. This value is based on the project currency.

Show Source

• Array of: number(double)

{
    "type":"array",
    "description":"The remaining cost for the resource assignment on the activity. This value is based on the project currency.",
    "exampleSetFlag":false,
    "items":{
        "type":"number",
        "format":"double",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : remainingUnits

Type: array

The remaining units of work to be performed by the resource on the activity.

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "description":"The remaining units of work to be performed by the resource on the activity.",
    "exampleSetFlag":false,
    "items":{
        "type":"integer",
        "format":"int64",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : spreadDates

Type: array

The list of spread dates derived according to the timescale for all the spread items in the request.

Show Source

• Array of: string(date-time)

{
    "type":"array",
    "description":"The list of spread dates derived according to the timescale for all the spread items in the request.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "format":"date-time",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

400 Response

Invalid input for the Action service.

Back to Top