PUT api/projects/budget?filterBy={filterBy}

Updates financial data for one or more projects based on a specified filter.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
filterBy

The field used to identify projects. Accepts `"projectId"` or a metadata field label or GUID.

string

Required

Body Parameters

A list of project change items containing the values to match and the financial data to update.

Collection of ProjectChangeItem
NameDescriptionTypeAdditional information
filterValue

string

None.

id

integer

None.

actualOOP

ProjectOOPList

None.

Request Formats

application/json, text/json, application/scim+json

Sample:
[
  {
    "filterValue": "sample string 1",
    "id": 2,
    "actualOOP": {
      "mode": "sample string 1",
      "expenses": [
        {
          "category": "sample string 1",
          "item": "sample string 2",
          "amount": 3.1
        },
        {
          "category": "sample string 1",
          "item": "sample string 2",
          "amount": 3.1
        }
      ]
    }
  },
  {
    "filterValue": "sample string 1",
    "id": 2,
    "actualOOP": {
      "mode": "sample string 1",
      "expenses": [
        {
          "category": "sample string 1",
          "item": "sample string 2",
          "amount": 3.1
        },
        {
          "category": "sample string 1",
          "item": "sample string 2",
          "amount": 3.1
        }
      ]
    }
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

On success: HTTP 200 OK with a summary of updated and failed project updates. On failure: HTTP 400 Bad Request with an error message.

ProjectChangeResponse
NameDescriptionTypeAdditional information
updated

Collection of ProjectResultItem

None.

failed

Collection of ProjectErrorItem

None.

Response Formats

application/json, text/json, application/scim+json

Sample:
{
  "updated": [
    {
      "filterValue": "sample string 1",
      "id": 2,
      "title": "sample string 3"
    },
    {
      "filterValue": "sample string 1",
      "id": 2,
      "title": "sample string 3"
    }
  ],
  "failed": [
    {
      "filterValue": "sample string 1",
      "status": "sample string 2"
    },
    {
      "filterValue": "sample string 1",
      "status": "sample string 2"
    }
  ]
}