Sign in

v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB
Allocations

Update an allocation

Updates the allocation specified by the Id.

patch/analytics/v1/allocations/{id}

Path parameters

idstring required

Allocation ID

Request body

namestring nullable

Allocation name

descriptionstring nullable

Allocation description

unallocatedCostsstring nullable

Custom label for values that do not fit into allocation (required for group type allocation).

folderIdstring

Identifier of the folder that contains the allocation. Set to "root" if the allocation is at the top level (not in a folder).

Example request

{
  "rule": {
    "formula": "A AND B"
  },
  "rules": [
    {
      "formula": "A AND B"
    }
  ],
  "folderId": "root"
}

Response

OK - Allocation updated.

idstring

Allocation ID.

namestring

Allocation name.

descriptionstring

Allocation description.

typestring

Type of allocation (preset or custom).

allocationType'single' | 'group'

Composition type of allocation.

createTimeinteger

The time when the allocation was created (in UNIX timestamp).

updateTimeinteger

Last time the allocation was modified (in UNIX timestamp).

anomalyDetectionboolean nullable

Whether anomaly detection is enabled for this allocation.

unallocatedCostsstring nullable

Custom label for values that do not fit into allocation (required for group type allocation).

folderIdstring

Identifier of the folder that contains the allocation. Set to "root" if the allocation is at the top level (not in a folder).

Example response

{
  "rule": {
    "formula": "A AND B"
  },
  "rules": [
    {
      "formula": "A AND B"
    }
  ],
  "folderId": "root"
}