Skip to main content
PATCH
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
assignments
/
{assignment_id}
Update Assignment
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    data_owner_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    data_owner_email: 'jsmith@example.com'
  })
};

fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/assignments/{assignment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data_owner_email": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "facility_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data_owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-organization-id
string
​
x-api-key
string
​
x-user-id
string

Path Parameters

​
assignment_id
string<uuid>
required
​
dataset_id
string<uuid>
required

Body

application/json

Request schema for updating an existing dataset assignment.

​
data_owner_user_id
string<uuid>
​
data_owner_email
string<email>

Response

Successful Response

Dataset-scoped assignment row (contact info only).

​
id
string<uuid>
required

The assignment id.

​
dataset_id
string<uuid>
required

The parent dataset id.

​
organization_id
string<uuid>
required

The assigned organization id.

​
data_owner_email
string
required
​
created_at
string<date-time>
required
​
facility_id
string<uuid>

The assigned facility id.

​
data_owner_user_id
string<uuid>

The data owner user id.

​
updated_at
string<date-time>