Skip to content

Conflicts Of Interest

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/conflicts-of-interest/ List Conflicts Of Interest
GET /api/conflicts-of-interest/{uuid}/ Retrieve
PUT /api/conflicts-of-interest/{uuid}/ Update
PATCH /api/conflicts-of-interest/{uuid}/ Partial Update
Other Actions
POST /api/conflicts-of-interest/{uuid}/dismiss/ Dismiss a conflict of interest (not a real conflict)
POST /api/conflicts-of-interest/{uuid}/recuse/ Recuse reviewer from the proposal
POST /api/conflicts-of-interest/{uuid}/waive/ Waive a conflict with a management plan

Core CRUD

List Conflicts Of Interest

1
2
3
4
http \
  GET \
  https://api.example.com/api/conflicts-of-interest/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_severity_level import COISeverityLevel # (1)
from waldur_api_client.models.coi_type_enum import CoiTypeEnum # (2)
from waldur_api_client.models.conflict_of_interest_o_enum import ConflictOfInterestOEnum # (3)
from waldur_api_client.models.conflict_of_interest_status_enum import ConflictOfInterestStatusEnum # (4)
from waldur_api_client.models.detection_method_enum import DetectionMethodEnum # (5)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_list # (6)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = conflicts_of_interest_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: COISeverityLevel
  2. Model Source: CoiTypeEnum
  3. Model Source: ConflictOfInterestOEnum
  4. Model Source: ConflictOfInterestStatusEnum
  5. Model Source: DetectionMethodEnum
  6. API Source: conflicts_of_interest_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { conflictsOfInterestList } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
coi_type array
detection_method array
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
proposal_uuid string (uuid)
reviewer_name string
reviewer_uuid string (uuid)
round_uuid string (uuid)
severity string Enum: real, apparent, potential
status array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = conflicts_of_interest_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: conflicts_of_interest_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { conflictsOfInterestRetrieve } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.conflict_of_interest_request import ConflictOfInterestRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ConflictOfInterestRequest()
response = conflicts_of_interest_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ConflictOfInterestRequest
  2. API Source: conflicts_of_interest_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { conflictsOfInterestUpdate } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string
Enum: pending, dismissed, waived, recused
review_notes string
management_plan string If waived, how is it managed

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_conflict_of_interest_request import PatchedConflictOfInterestRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedConflictOfInterestRequest()
response = conflicts_of_interest_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedConflictOfInterestRequest
  2. API Source: conflicts_of_interest_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { conflictsOfInterestPartialUpdate } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string
Enum: pending, dismissed, waived, recused
review_notes string
management_plan string If waived, how is it managed

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Other Actions

Dismiss a conflict of interest (not a real conflict)

Dismiss a conflict of interest (not a real conflict).

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/dismiss/ \
  Authorization:"Token YOUR_API_TOKEN" \
  status="dismissed"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_status_update_request import COIStatusUpdateRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_dismiss # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = COIStatusUpdateRequest(
    status="dismissed"
)
response = conflicts_of_interest_dismiss.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: COIStatusUpdateRequest
  2. API Source: conflicts_of_interest_dismiss
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { conflictsOfInterestDismiss } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestDismiss({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "status": "dismissed"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string ✓
Enum: dismissed, waived, recused
review_notes string
management_plan string Required when status is 'waived'

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Recuse reviewer from the proposal

Recuse reviewer from the proposal.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/recuse/ \
  Authorization:"Token YOUR_API_TOKEN" \
  status="dismissed"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_status_update_request import COIStatusUpdateRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_recuse # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = COIStatusUpdateRequest(
    status="dismissed"
)
response = conflicts_of_interest_recuse.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: COIStatusUpdateRequest
  2. API Source: conflicts_of_interest_recuse
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { conflictsOfInterestRecuse } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestRecuse({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "status": "dismissed"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string ✓
Enum: dismissed, waived, recused
review_notes string
management_plan string Required when status is 'waived'

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Waive a conflict with a management plan

Waive a conflict with a management plan.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/waive/ \
  Authorization:"Token YOUR_API_TOKEN" \
  status="dismissed"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_status_update_request import COIStatusUpdateRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_waive # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = COIStatusUpdateRequest(
    status="dismissed"
)
response = conflicts_of_interest_waive.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: COIStatusUpdateRequest
  2. API Source: conflicts_of_interest_waive
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { conflictsOfInterestWaive } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestWaive({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "status": "dismissed"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string ✓
Enum: dismissed, waived, recused
review_notes string
management_plan string Required when status is 'waived'

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)