Skip to main content
PUT
/
api
/
Configuration
/
KPIs
/
user
/
{userId}
Get KPIs assigned to User
curl --request PUT \
  --url https://api.example.com/api/Configuration/KPIs/user/{userId} \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "allocatedKpis": [
    {
      "id": 123,
      "value": 123,
      "name": "<string>",
      "description": "<string>",
      "reoccuranceTypeId": 123,
      "reoccuranceType": "<string>",
      "effectiveDate": "2023-11-07T05:31:56Z"
    }
  ],
  "kpiIdsToAllocate": [
    123
  ],
  "kpiIdsToUnallocate": [
    123
  ],
  "kpiIdsToUpdate": [
    123
  ]
}
'
[
  {
    "id": 123,
    "customerId": 123,
    "name": "<string>",
    "description": "<string>",
    "reoccuranceTypeId": 123,
    "reoccuranceType": "<string>",
    "createdBy": 123,
    "createdDate": "2023-11-07T05:31:56Z",
    "isDeleted": true,
    "deletedById": 123,
    "deletedDate": "2023-11-07T05:31:56Z",
    "modifiedBy": 123,
    "modifiedDate": "2023-11-07T05:31:56Z",
    "lastProcessedDate": "2023-11-07T05:31:56Z",
    "metricDataJson": "<string>"
  }
]

Path Parameters

userId
integer<int32>
required

Body

allocatedKpis
object[] | null
kpiIdsToAllocate
integer<int32>[] | null
kpiIdsToUnallocate
integer<int32>[] | null
kpiIdsToUpdate
integer<int32>[] | null

Response

200 - application/json

OK

id
integer<int32>
customerId
integer<int32>
name
string | null
description
string | null
reoccuranceTypeId
integer<int32>
reoccuranceType
string | null
createdBy
integer<int32>
createdDate
string<date-time>
isDeleted
boolean | null
deletedById
integer<int32> | null
deletedDate
string<date-time> | null
modifiedBy
integer<int32> | null
modifiedDate
string<date-time> | null
lastProcessedDate
string<date-time> | null
metricDataJson
string | null