API docs by Redocly

COI (1.0.0)

Download OpenAPI specification:Download

Overview

Huron Conflict of Interest (COI) provides you a comprehensive, flexible, and integrated solution which simplifies the process of recording a discloser's interests and routing those interests through a systematic review process to manage both individual and institutional conflicts.

The COI API is implemented to manage conflict of interest between disclosure and organizations. It offers the following features.

Features

  • Flexible data model to accommodate a variety of potential conflicts of interest.
  • Support for workflows around both research and non-research activities.
  • Methods to track compliance and to trigger improved response rates.

Management Plan

A management plan is used to manage a discloser's conflict.

Use the Management Plan object to manage plans as per the institution’s requirements.

Retrieve actions for action log

Retrieves actions for action log by project hrn and its accessibility to the user for management plan.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:managementplan:[0-9]+$
Example: hrn:hrs:managementplan:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:managementplan:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Retrieve management plans for disclosure profile

Retrieves all the management plans associated with requested disclosure profile.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

planState
required
string
Example: Drafting, Active, Collaborating

Comma-separated string to pass one or more valid Management Plan project states to filter. Allowed values: PendingAcceptance, Drafting, Collaborating, Active, Satisfied

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Migrate management plan

Migrates management plan from v10 to v12.

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

id
string

ID of the management plan. This ID is from the legacy and is unique within the tenant.

certificationSourceIds
Array of strings

Certification Source ID from legacy.

name
string

Name of the management plan supplied at creation.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

planCreator
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

createdBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

projectState
string

The current state of the management plan in a project (e.g., Satisfied).

workflowState
string

The current state of the management plan in the workflow (e.g., Active).

planStatus
string

The current status of the management plan (e.g., Drafting).

stateLastUpdated
string <date-time>

The date and time the plan is last updated for state transition.

dateCreated
string <date-time>

The timestamp when the management plan was created.

dateModified
string <date-time>

The date and time the management plan was last changed, or an activity was executed on the management plan.

Array of objects (PersonRef)

The details of the plan monitors associated with the management plan.

object

Documents and details for the management plan.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "certificationSourceIds": [
    ],
  • "name": "string",
  • "discloser": {
    },
  • "planCreator": "string",
  • "createdBy": "string",
  • "projectState": "string",
  • "workflowState": "string",
  • "planStatus": "string",
  • "stateLastUpdated": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "planMonitors": [
    ],
  • "planDocument": {
    }
}

Response samples

Content type
application/json
{
  • "hrn": "string"
}

Create Management Plan Import

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects

Responses

Request samples

Content type
application/json
{
  • "idFieldName": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Update management plan activity state

Updates the management plan activity state record as specified in the request body. This creates activity logs and sends notifications.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:managementplan:[0-9]+$
Example: hrn:hrs:managementplan:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:managementplan:resource_id.

action
required
string
Enum: "RoutePlan" "AssignPlanCreator" "AssignMonitors" "ReturnPlanToDrafting" "Withdraw" "UpdateConflicts" "ReassignCertification" "UploadManagementPlan"
Example: RoutePlan

Action to be performed on the Project.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
comments
string

Comments on the action performed.

nextStep
string
Enum: "CollaborateOnPlan" "SendPlanForAcceptance" "AdministrativelyAcceptPlan"

Next step of the route plan. The following are the three options for next step:

  • Collaborate On Plan
  • Send plan for acceptance, and
  • Administratively accept plan
object

Supporting Document of the action.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

Responses

Request samples

Content type
application/json
Example
{
  • "comments": "string",
  • "nextStep": "CollaborateOnPlan",
  • "supportingDocuments": {
    },
  • "actionLogFormData": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List management plans

Returns a list of management plans.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve management plan

Retrieves a management plan based on ID.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:managementplan:[0-9]+$
Example: hrn:hrs:managementplan:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:managementplan:resource_id.

query Parameters
include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update management plan

Updates partial data in a management plan record specified by the HRN to reflect values included in the request body, which includes certain properties in appropriate JSON format. Fields with dependencies are still validated, even though those fields are not in the request body.

This operation is idempotent (i.e., if it is submitted multiple times, it will have the same effect as it did the first time).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:managementplan:[0-9]+$
Example: hrn:hrs:managementplan:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Request Body schema: application/json
required

A JSON object including partial fields

required
object (DocumentRef)

Responses

Request samples

Content type
application/json
{
  • "planDocument": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve management plan state

Retrieves the current state of the management plan.

Authorizations:
tokenAuthorizer
path Parameters
state
required
string
Enum: "PendingAcceptance" "Drafting" "Collaborating" "Active" "Satisfied"
Example: Drafting

Accepts a valid Management Plan project state to filter. Allowed values: PendingAcceptance, Drafting, Collaborating, Active, Satisfied

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve conflicts

Retrieves conflicts based on Plan HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:managementplan:[0-9]+$
Example: hrn:hrs:managementplan:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:managementplan:resource_id.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve pending acceptance

Retrieves a pending acceptance based on ID.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List conflicts

Returns a list of conflicts based on HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:managementplan:[0-9]+$
Example: hrn:hrs:managementplan:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:managementplan:resource_id.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve unassigned

Retrieves an unassigned based on ID.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve person list with COIA role

Retrieves a person list which contains the persons having COIA role and Cert reviewer.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:managementplan:[0-9]+$
Example: hrn:hrs:managementplan:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:managementplan:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Retrospective Review

A retrospective review is performed when issues arise that might impact the integrity of a research project.

Use the Retrospective Review object to create and update the retrospective review records.

List retrospective reviews

Returns a list of retrospective reviews on the basis of Pagination , Filters and sort applied.By default it will be returning a list of 25 records.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Create retrospective review

Creates the retrospective review record as specified in the request body, and returns system generated identifier retrospective review HRN.

This endpoint is also used for V10 to V12 migration of retrospective review. This method contains fields such as isMigrated, dateCreated, dateModified, and createdBy which are only used for V10 to V12 migration of retrospective review.

This operation is not idempotent (i.e., if it is executed multiple times, it will create multiple records, and return a different new HRN for each one).

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

name
required
string

Name of the retrospective review.

id
string <= 55 characters

An identifier generated during creation of the retrospective review. Each ID is unique within the tenant.

required
object

Details of the discloser.

NOTE: For v10 to v12 migration, the expected value is only the HRN of discloser.

reasonForReview
string

Details of the reason why retrospective review was performed.

discoveryDate
required
string <date-time>

Date that the institution reached a conclusion that non-compliance had occurred.

NOTE: Only past dates are valid.

methodology
string

Details for explaining the retrospective review (e.g., document reviewed).

findingsOfReview
string

Details of a particular retrospective review.

Array of objects (DocumentRef)

Details of the supporting documents.

NOTE: For V10 to V12 migration, the expected value is only hrn of documents.

Array of objects (TriggeringEventDetail)

Details of the related projects.

NOTE: For V10 to V12 migration, the expected value is only the hrn of projects. This property is not required and can be only used in case of migration

Array of objects (Entities)

Details of the conflicting entities.

NOTE: For V10 to V12 migration, the expected value is only the HRN of Entities. This property is not required and can be only used in case of migration

isMigrated
boolean

Indicates whether retrospective review record is migrated. The values are true or false. Set the value to TRUE for migration. This is a required field for V10 to V12 migration and is only used for migration.

dateCreated
string <date-time>

Date retrospective review record was created.

This field is used only for V10 to V12 migration.

dateModified
string <date-time>

The timestamp indicating the last time a retrospective review record was modified.

This field is used only for V10 to V12 migration.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Request samples

Content type
application/json
{
  • "name": "DAST Test Retrospective",
  • "id": "RETRO00000036",
  • "discloser": {
    },
  • "reasonForReview": "test lambda",
  • "discoveryDate": "2022-02-11T00:00:00",
  • "findingsOfReview": "nothing",
  • "methodology": "Scrum",
  • "supportingDocuments": [
    ]
}

Response samples

Content type
application/json
{
  • "hrn": "string"
}

Retrieve conflicting entities

Retrieves conflicting entities based on Person HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve retrospective review

Retrieves a retrospective review based on HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:retrospectivereview:[0-9]+$
Example: hrn:hrs:retrospectivereview:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:retrospectivereview:resource_id.

query Parameters
include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "discloser": {
    },
  • "reasonForReview": "string",
  • "discoveryDate": "2019-08-24T14:15:22Z",
  • "methodology": "string",
  • "findingsOfReview": "string",
  • "supportingDocuments": [
    ],
  • "relatedProjects": [
    ],
  • "conflictingEntities": [
    ],
  • "isMigrated": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "hrn": "string",
  • "retrospective_review_id": 26611,
  • "discloserFirstName": "Gaurav",
  • "discloserLastName": "Wairagade",
  • "assignedReviewerDisplayName": "Gaurav Wairagade",
  • "projectStateDisplayName": "In Review",
  • "workflowState": "InReview",
  • "dateModifiedFormatted": "2025-05-04T00:01:00Z",
  • "stateLastUpdated": "2025-05-03T23:21:46Z",
  • "daysInCurrentState": 1,
  • "pendingDiscloserUpdate": true,
  • "projectStateId": "string",
  • "assignReviewer": {
    },
  • "active": true,
  • "smartformSteps": [
    ],
  • "customProperties": { }
}

Replace retrospective review

Updates retrospective review record specified by the retrospective review ID to reflect all values included in the request body, which must be a complete record in the appropriate JSON format, including all fields that are normally optional for the POST operation. All the fields are updated.

This operation is idempotent (i.e., if it is submitted multiple times, it will have the same effect as it did the first time).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:retrospectivereview:[0-9]+$
Example: hrn:hrs:retrospectivereview:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:retrospectivereview:resource_id.

Request Body schema: application/json
required

A JSON object including all fields

id
string <= 55 characters

An identifier generated during creation of the retrospective review. Each ID is unique within the tenant.

required
object

Details of the discloser.

NOTE: For v10 to v12 migration, the expected value is only the HRN of discloser.

name
required
string

Name of the retrospective review.

findingsOfReview
string

Details of a particular retrospective review.

reasonForReview
string

Details of the reason why retrospective review was performed.

methodology
string

Details for explaining the retrospective review (e.g., document reviewed).

discoveryDate
required
string <date-time>

Date that the institution reached a conclusion that non-compliance had occurred.

NOTE: Only past dates are valid.

Array of objects (DocumentRef)

Details of the supporting documents.

NOTE: For V10 to V12 migration, the expected value is only hrn of documents.

Array of objects (TriggeringEventDetail)

Details of the related projects.

NOTE: For V10 to V12 migration, the expected value is only the hrn of projects.

Array of objects (Entities)

Details of the conflicting entities.

NOTE: For V10 to V12 migration, the expected value is only the HRN of Entities.

projectStateId
string

State identifier of the retrospective review project (e.g., InReview).

previousProjectStateId
string

State identifier of the previous retrospective review project.

NOTE: For V10 to V12 migration, previous project state is not necessary.

Array of objects (SubmitRetrospectiveReview)

Details of Submit retrospective review Action.

Array of objects (SubmitMitigationPlan)

Details of Submit Mitigation Plan Action.

Array of objects (PersonRef)

Details of the assigned reviewer.

NOTE: For V10 to V12 migration, the expected value is only the hrn of assigned reviewer.

isMigrated
boolean

Indicates whether retrospective review record is migrated. The values are true or false. Set the value to TRUE for migration. This is a required field for V10 to V12 migration and is only used for migration.

dateCreated
string <date-time>

Date retrospective review record was created.

This field is used only for V10 to V12 migration.

dateModified
string <date-time>

The timestamp indicating the last time a retrospective review record was modified.

This field is used only for V10 to V12 migration.

createdBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (SmartformStep)

Active Flex steps for retrospective review configured in Step Flex Settings.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "discloser": {
    },
  • "name": "string",
  • "findingsOfReview": "string",
  • "reasonForReview": "string",
  • "methodology": "string",
  • "discoveryDate": "2021-03-30T10:05:30.000Z",
  • "supportingDocuments": [
    ],
  • "relatedProjects": [
    ],
  • "conflictingEntities": [
    ],
  • "projectStateId": "string",
  • "previousProjectStateId": "string",
  • "submitRetrospectiveReview": [
    ],
  • "submitMitigationPlan": [
    ],
  • "assignReviewer": [
    ],
  • "isMigrated": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "smartformSteps": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string",
  • "code": 0,
  • "links": {
    }
}

Update retrospective review

Updates partial data in specified retrospective review record specified by the HRN to reflect values included in the request body, which includes certain properties in appropriate JSON format. Fields with dependencies are still validated, even though those fields are not in the request body.

This operation is idempotent (i.e., if it is submitted multiple times, it will have the same effect as it did the first time).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:retrospectivereview:[0-9]+$
Example: hrn:hrs:retrospectivereview:50

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Request Body schema: application/json
required

A JSON object including partial fields

id
string <= 55 characters

An identifier generated during creation of the retrospective review. Each ID is unique within the tenant.

required
object

Details of the discloser.

NOTE: For v10 to v12 migration, the expected value is only the HRN of discloser.

name
required
string

Name of the retrospective review.

findingsOfReview
string

Details of a particular retrospective review.

reasonForReview
string

Details of the reason why retrospective review was performed.

methodology
string

Details for explaining the retrospective review (e.g., document reviewed).

discoveryDate
required
string <date-time>

Date that the institution reached a conclusion that non-compliance had occurred.

NOTE: Only past dates are valid.

Array of objects (DocumentRef)

Details of the supporting documents.

NOTE: For V10 to V12 migration, the expected value is only hrn of documents.

Array of objects (TriggeringEventDetail)

Details of the related projects.

NOTE: For V10 to V12 migration, the expected value is only the hrn of projects.

Array of objects (Entities)

Details of the conflicting entities.

NOTE: For V10 to V12 migration, the expected value is only the HRN of Entities.

projectStateId
string

State identifier of the retrospective review project (e.g., InReview).

previousProjectStateId
string

State identifier of the previous retrospective review project.

NOTE: For V10 to V12 migration, previous project state is not necessary.

Array of objects (SubmitRetrospectiveReview)

Details of Submit retrospective review Action.

Array of objects (SubmitMitigationPlan)

Details of Submit Mitigation Plan Action.

Array of objects (PersonRef)

Details of the assigned reviewer.

NOTE: For V10 to V12 migration, the expected value is only the hrn of assigned reviewer.

isMigrated
boolean

Indicates whether retrospective review record is migrated. The values are true or false. Set the value to TRUE for migration. This is a required field for V10 to V12 migration and is only used for migration.

dateCreated
string <date-time>

Date retrospective review record was created.

This field is used only for V10 to V12 migration.

dateModified
string <date-time>

The timestamp indicating the last time a retrospective review record was modified.

This field is used only for V10 to V12 migration.

createdBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (SmartformStep)

Active Flex steps for retrospective review configured in Step Flex Settings.

Responses

Request samples

Content type
application/json
{
  • "name": "TE",
  • "discoveryDate": "2025-04-03T07:00:00Z",
  • "discloser": {
    },
  • "findingsOfReview": "finds of a review",
  • "methodology": "Scrum",
  • "reasonForReview": "reason for review given",
  • "supportingDocuments": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string",
  • "code": 0,
  • "links": {
    }
}

Retrieve related research projects

Retrieves related research projects based on Person HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Update retrospective review

Updates the retrospective review activity state record as specified in the request body. This action creates activity logs and sends notifications.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:retrospectivereview:[0-9]+$
Example: hrn:hrs:retrospectivereview:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:retrospectivereview:resource_id.

action
required
string
Enum: "SubmitRetrospectiveReview" "SubmitMitigationPlan" "Comment" "AssignReviewer" "Discard" "BypassAncillaryBlock"
Example: SubmitRetrospectiveReview

Action to be performed on the Project.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
hasBias
required
boolean

Indicates whether extra verification is needed for the retrospective review record. The values are Yes or No. Set to YES if SubmitMitigationPlan action needs to be performed.

comments
string

Extra information for SubmitRetrospectiveReview action .

Array of objects (DocumentRef)

Information about the supporting documents.

NOTE: For v10 to v12 migration, the expected value is only the HRN of documents.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

customProperties
object

Custom properties or additional fields.

Responses

Request samples

Content type
application/json
{
  • "comments": "This is DAST Comment",
  • "supportingDocuments": [ ],
  • "actionLogFormData": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve actions for action log

Retrieves actions for action log by project hrn and its accessibility to the user for retrospective review.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:retrospectivereview:[0-9]+$
Example: hrn:hrs:retrospectivereview:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:retrospectivereview:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Triggering Event

Triggering events are events that require a person’s interests to be reviewed by the COI office.

Use the Triggering Event object to create, manage, and update the triggering events.

List triggering events

Returns a list of triggering events.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Create triggering events

Creates the triggering events record as specified in the request body, and returns system generated identifier triggering events ID.

This operation is not idempotent (i.e., if it is executed multiple times, it will create multiple records, and return a different note ID for each one).

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
id
required
string

A unique alpha-numeric identifier for the Triggering Event. If provided in the request, it will be used; otherwise, a unique identifier will be system-generated. Each ID is unique within the tenant.

dateCreated
required
string <date-time>

The timestamp when the management plan was created.

title
required
string

The title of the triggering event provided at creation.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

startDate
string <date-time>

The date the triggering event project is estimated to start.

endDate
string <date-time>

The date the triggering event project is estimated to end.

object (MigrateOrImportPersonHrn) ^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (ResearchPersonnel)
sponsor
string (MigrateOrImportOrganizationHrn) ^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

associatedOrganizations
Array of strings (MigrateOrImportOrganizationHrn) [^hrn:hrs:orgs:[0-9]+$]
associatedInternalOrganizations
Array of strings (MigrateOrImportOrganizationHrn) [^hrn:hrs:orgs:[0-9]+$]
scope
string

The scope of the triggering event project.

drugsAndTechnology
string

The description of the drugs and technology involved in the triggering event project.

Array of DocumentRef (object) or MigrateOrImportDocumentHrn (string)
customProperties
object

A JSON object that contains the Flex data conforming to the List Items custom object definitions.

adminContacts
Array of strings[^hrn:hrs:persons:[0-9]+$]

List of HRNs of Related Project Assigned Coordinator / Administrative Contacts from the source system.

relatedProjectHrn
string (HRN)

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "TE00004747",
  • "dateCreated": "2021-03-30T10:05:30Z",
  • "title": "Provident Funds Triggering Event",
  • "primaryContact": {
    },
  • "eventType": {
    },
  • "startDate": "2025-05-01T10:00:00.000Z",
  • "endDate": "2025-05-31T10:00:00.000Z",
  • "principalInvestigator": {
    },
  • "researchPersonnel": [
    ],
  • "sponsor": "string",
  • "associatedOrganizations": [
    ],
  • "associatedInternalOrganizations": [
    ],
  • "scope": "string",
  • "drugsAndTechnology": "Lorem ipsum dolor sit amet.",
  • "supportingDocuments": [
    ],
  • "customProperties": {
    },
  • "adminContacts": [
    ],
  • "relatedProjectHrn": "string"
}

Response samples

Content type
application/json
{
  • "hrn": "string"
}

Retrieve triggering event

Retrieves the triggering event based on HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

query Parameters
include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "hrn": "string",
  • "id": "string",
  • "triggering_event_id": 0,
  • "title": "string",
  • "eventType": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "projectStateId": "string",
  • "assignCoordinator": {
    },
  • "primaryContactDisplayName": "string",
  • "principalInvestigatorDisplayName": "string",
  • "endDateFormatted": "2019-08-24T14:15:22Z",
  • "dateModifiedFormatted": "2019-08-24T14:15:22Z",
  • "relatedContextDP": [
    ],
  • "active": true,
  • "projectStateDisplayName": "string"
}

Update triggering event

Updates partial data in specified a triggering event record specified by the HRN to reflect values included in the request body, which includes certain properties in appropriate JSON format. Fields with dependencies are still validated, even though those fields are not in the request body.

This operation is idempotent (i.e., if it is submitted multiple times, it will have the same effect as it did the first time).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string
Example: hrn:hrs:triggeringevent:845

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Request Body schema: application/json
required

A JSON object including partial fields

title
string

The title of the triggering event provided at creation.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

startDate
string <date-time>

The date the triggering event project is estimated to start.

endDate
string <date-time>

The date the triggering event project is estimated to end.

object (MigrateOrImportPersonHrn) ^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (ResearchPersonnel)
sponsor
string (MigrateOrImportOrganizationHrn) ^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

associatedOrganizations
Array of strings (MigrateOrImportOrganizationHrn) [^hrn:hrs:orgs:[0-9]+$]
associatedInternalOrganizations
Array of strings (MigrateOrImportOrganizationHrn) [^hrn:hrs:orgs:[0-9]+$]
scope
string

The scope of the triggering event project.

drugsAndTechnology
string

The description of the drugs and technology involved in the triggering event project.

Array of DocumentRef (object) or MigrateOrImportDocumentHrn (string)
customProperties
object

A JSON object that contains the Flex data conforming to the List Items custom object definitions.

adminContacts
Array of strings[^hrn:hrs:persons:[0-9]+$]

List of HRNs of Related Project Assigned Coordinator / Administrative Contacts from the source system.

relatedProjectHrn
string (HRN)

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

Responses

Request samples

Content type
application/json
{
  • "title": "Provident Funds Triggering Event",
  • "primaryContact": {
    },
  • "eventType": {
    },
  • "startDate": "2025-05-01T10:00:00.000Z",
  • "endDate": "2025-05-31T10:00:00.000Z",
  • "principalInvestigator": {
    },
  • "researchPersonnel": [
    ],
  • "sponsor": "string",
  • "associatedOrganizations": [
    ],
  • "associatedInternalOrganizations": [
    ],
  • "scope": "string",
  • "drugsAndTechnology": "Lorem ipsum dolor sit amet.",
  • "supportingDocuments": [
    ],
  • "customProperties": {
    },
  • "adminContacts": [
    ],
  • "relatedProjectHrn": "string"
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string",
  • "code": 0,
  • "links": {
    }
}

Create Triggering Event Import

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects

Responses

Request samples

Content type
application/json
{
  • "idFieldName": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Update triggering event activity state

Updates the triggering event activity state record as specified in the request body. This creates activity logs.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

action
required
string
Enum: "AssignCoordinator" "CloseTriggeringEvent" "OpenTriggeringEvent"
Example: AssignCoordinator

Action to be performed on the Project.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
required
object

A single selection person chooser in which we select the coordinator.

comments
string

Comment on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

Responses

Request samples

Content type
application/json
{
  • "coordinator": {
    },
  • "comments": "Something In Comment",
  • "actionLogFormData": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string",
  • "code": 0,
  • "links": {
    }
}

List related research project

Returns a list of related Triggering Events associated to Person's Certifications.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Manage certifications

Manages the triggering event by creating a certification.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string",
  • "code": 0,
  • "links": {
    }
}

Reinitiate certifications

Reinitiate the triggering event by reinitiating the certifications.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string",
  • "code": 0,
  • "links": {
    }
}

Retrieve actions for action log

Retrieves actions for action log by project hrn and its accessibility to the user for triggering event.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Retrieve triggering event access

Retrieve the details and checks if the user has access to a triggering event.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string",
  • "code": 0,
  • "links": {
    }
}

Retrieve manage certifications status

Retrieves execution status of manage ,reinitiate certifications activity for triggering event.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

action_name
required
string
Example: reinitiate-certifications,manage-certifications

Action name from TE (reinitiate-certifications, manage-certifications).

Responses

Response samples

Content type
application/json
{
  • "status": "RUNNING"
}

Certification

A certification is a project that contains disclosure profile details from a point in time, tracks the review of the disclosure profile, and documents the reviewers’ determinations and findings.

Use the Certification object to create, update, and review information of certifications for a research project.

List current certifications

Returns a list of current certifications.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List Historical Certifications for TE

Returns a list of Historical Certifications for triggering event.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List previous certifications for TE

Returns a list of previous certifications for triggering event.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List all certifications for TE of current Principal Investigator and RPA

Returns a list of all certifications for TE of current Principal Investigator and RPA.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve actions for action log

Retrieve actions for action log by project hrn and its accessibility to the user for certification.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:371

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List snapshots

Returns a list of certification snapshots.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:371

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{}

List certifications

Return a list of certifications.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Create certification

NOTE: THIS IS MAINLY USED FOR MIGRATION OF LEGACY DATA.

Creates the certification record as specified in the request body, and returns system generated identifier Certification ID.

This operation is not idempotent (i.e., if it is executed multiple times, it will create multiple records, and return a different note ID for each one).

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

object (CertificationData)

Responses

Request samples

Content type
application/json
{
  • "certification": {
    }
}

Response samples

Content type
application/json
{
  • "hrn": "string"
}

Create Certification Import

NOTE: THIS IS MAINLY USED FOR MIGRATION OF LEGACY DATA.

Creates the certification record as specified in the request body, and returns system generated identifier Certification ID.

This operation is not idempotent (i.e., if it is executed multiple times, it will create multiple records, and return a different note ID for each one).

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects

Responses

Request samples

Content type
application/json
{
  • "idFieldName": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve certification

Retrieves a certification based on HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Patch certification

NOTE: THIS IS MAINLY USED FOR MIGRATION OF LEGACY DATA.

Update the certification name.

This operation is not idempotent (i.e., if it is executed multiple times, it will create multiple records, and return a different note ID for each one).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

object (CertificationPatchData)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve certification by state

Retrieves a certification based on the state.

Authorizations:
tokenAuthorizer
path Parameters
state
required
string

State of the certification (e.g., AwaitingProfileUpdate).

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve clarification

Retrieves a clarification based on ID. Clarification is used for sending questions/messages for the discloser.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "clarification_id": 4778,
  • "certification_id": 13910,
  • "cert_id": "CERT00066262",
  • "tenant_id": 1,
  • "disclosure_profile_hrn": "hrn:hrs:disclosureprofile:2290",
  • "request_text": "test",
  • "request_date": "2025-02-05T08:00:00.0000000Z",
  • "date_created": "2025-02-05T15:34:57.0000000Z",
  • "response_submitted": false,
  • "additional_response_due_date": "2025-02-05T15:34:56.3198260Z",
  • "additional_clarification_description": [
    ],
  • "requestor": {
    }
}

Update certification activity state

Updates the certification activity state record as specified in the request body. This action creates activity logs and sends notifications.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

action
required
string
Enum: "AssignReviewer" "SubmitMyReview" "SubmitReview" "ResetReviewStages" "ApplyTag" "RemoveTag" "ReturnForReview" "AssignToCommitteeReview" "Withdraw" "RequestClarification" "ManageClarification" "SCRReview" "ReassignManagementPlan" "AssignToMeeting" "RemoveFromAgenda"
Example: assignreviewer

Action ID of a particular action.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
required
object (MigrateOrImportPersonHrn) ^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

customProperties
object

Custom properties or additional fields.

Responses

Request samples

Content type
application/json
Example
{
  • "reviewer": {
    },
  • "actionLogFormData": [
    ],
  • "customProperties": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update certification

Updates the certification activity state record as specified in the request body. This action creates activity logs and sends notifications.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

action
required
string
Value: "AssignReviewer"
Example: assignreviewer

Action ID of a particular action.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
required
object (MigrateOrImportPersonHrn) ^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

customProperties
object

Custom properties or additional fields.

Responses

Request samples

Content type
application/json
{
  • "reviewer": {
    },
  • "actionLogFormData": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve certifications of a research project

Retrieves certifications of a research project.

Authorizations:
tokenAuthorizer
path Parameters
researchProjectId
required
string

Unique ID of the research project.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve review information of certifications

Retrieves review information of certifications based on HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieve assigned reviewer

Retrieves assigned reviewer details based on HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve certifications review stages information

Retrieves current-review-stages and new-review-stages information of a certifications.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieve all stages information of certifications

Retrieves all stages intermediate review stages and final review stage information of the certifications.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieve plan certifications

Retrieves plan certifications for reassign certification action.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:managementplan:[0-9]+$
Example: hrn:hrs:managementplan:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List Research Certifications Portfolio

Returns a list of Research Certifications Portfolio.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve final review information

Retrieves final review and latest review information of the certifications.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string
Example: hrn:hrs:certification:114

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "hrn": "string",
  • "id": "string",
  • "discloser": {
    },
  • "name": "string",
  • "eventType": "string",
  • "principalInvestigator": {
    },
  • "assignedReviewer": [
    ],
  • "certificationType": "Research"
}

Central Action

Central Action allows an administrator to execute activities on multiple projects at once.

Use the Central Action object to create, update, and review the central action activities.

List proxy assignments

Based on the institution's settings, a proxy can perform various actions on behalf of the discloser.

Returns a list of proxy assignments.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List review workflow templates

A workflow template is used for certifications to be reviewed. Not all the certifications require a review. The certifications that require review are routed according to the applicable workflow template.

Returns a list of review workflow templates.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List eligible proxies

A proxy is a person who is authorized to manage disclosures for a discloser.

Returns a list of eligible proxies.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List admin offices

An admin office is a central office (such as Research Compliance, General Counsel, Provost’s Office, Procurement) that consists of individuals who can review certifications, pre-approval requests, or other activities in the COI system.

Returns a list of admin offices.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List certification type

A certification is created automatically by the system or manually by the COI Administrator (COIA). There are multiple certification types.

Non-research: Generic certification types that you configure so the reviews occur at intervals that meet your institution’s policies.

Research: This purpose-built certification type is meant for reviews driven primarily by specific research projects instead of configured intervals.

Returns a list of certification types with category.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List categories

Returns a list of categories.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List categories by its HRN

Returns a list of categories by its HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Update Central Action

Updates the Central Action activity state record as specified in the request body and creates activity logs.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

path Parameters
action
required
string
Enum: "ManageProxyAssignments" "ManageEligibleProxies" "AdminOffices" "deactivatedisclosureprofiles" "reactivatedisclosureprofiles" "ManageWriteInEntities" "ReviewWorkflowTemplates"
Example: ManageProxyAssignments

Action ID.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
object (ProxyAssignment)
Array of objects (actionLogFormData)

Metadata about the form fields shown in the action log interface.

Responses

Request samples

Content type
application/json
Example
{
  • "manageProxyAssignments": {
    },
  • "actionLogFormData": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Execute Central Actions

Updates the Central Action activity state record as specified in the request body and creates activity logs.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
action
required
string
Enum: "CreateCertificationsBulkProcess" "ManageCategoryPersonnelBulkProcess" "CreateDisclosureProfileBulkProcess" "ExpireTrainingBulkProcess" "ForceProfileUpdateBulkProcess"
Example: managecategorypersonnelbulkprocess

Action ID.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
required
Array of objects (PersonRef)

Information about persons.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

Responses

Request samples

Content type
application/json
Example
{
  • "persons": [
    ],
  • "actionLogFormData": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve actions for action log

Retrieves actions for action log by project hrn and its accessibility to the user.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Retrieve Central Action Execution Status

Retrieves execution status of the latest bulk processing activity on COI Central Actions.

Authorizations:
tokenAuthorizer
path Parameters
action
required
string
Example: manage-category-personnel, expire-training

Central Actions action ID.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "executionArn": "string"
}

List Central Action execution status records

Returns a list of execution status records of the latest bulk processing activity on COI Central Actions.

Authorizations:
tokenAuthorizer
path Parameters
action
required
string
Example: manage-category-personnel, expire-training

Central Actions action ID.

status
required
string

Status of the action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve Central Action execution status

Retrieves execution status of the latest bulk processing activity on COI Central Actions.

Authorizations:
tokenAuthorizer
path Parameters
status
required
string

Status of the action.

executionid
required
string

Unique execution ID.

actionid
required
string
Example: manage-category-personnel, expire-training

Central Actions action ID.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": {
    },
  • "data": [
    ],
  • "links": {
    }
}

List personnel

Returns a list of all personnel. To list personnel's details use filter [active]= true.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": {
    },
  • "data": [
    ],
  • "links": {
    }
}

Count all personnel

Returns a count of all personnel.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List category personnel

Category personnel are the list of users assigned to a COI category. A category uses a common set of criteria for prompting the personnel to disclose or take COI training.

Returns a list of category personnel based on the category.

Authorizations:
tokenAuthorizer
path Parameters
category
required
string
Example: Research, nonresearch1

Category Id. To add multiple categories, use a comma-separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "data": [
    ],
  • "links": {
    }
}

Check requiring profiles

Checks requiring profiles for disclosure profile.

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

Array of objects (RequiringPerson)

Responses

Request samples

Content type
application/json
{
  • "personnel": [
    ]
}

Response samples

Content type
application/json
{
  • "data": { }
}

Settings

Settings permit to make changes to some of the look and feel elements, as well as giving the ability to select from a variety of specific functional behaviors in the COI module.

Retrieve proxy settings

Setting to manage Proxies. Retrieves proxy settings for the discloser to enable different levels of privilege for proxies. This involves the process of accessing and configuring proxy settings for a discloser.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "enableProxyFunctionality": "string",
  • "allowProxyDiscloserProfile": "string",
  • "allowProxyCompleteDiscloserProfile": "string",
  • "allowProxySubmitPreApprovalRequest": "string",
  • "allowProxyClarificationsRequest": "string",
  • "allowProxyReview": "string",
  • "allowDiscloserManageProxy": "string"
}

Retrieve disclosure types Settings

Retrieves disclosure types Settings which involves retrieving various disclosure types that enable a discloser to report their outside activities and/or financial interests.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "disclosureTypesName": "string",
  • "disclosureTypesDescription": "string",
  • "disclosureTypesCategories": [
    ],
  • "disclosureTypesStatus": true,
  • "disclosureTypeDisplayOrder": 0,
  • "disclosureType": "string",
  • "enableCapturingVentureCapital": true
}

Retrieve request types Settings

Retrieves request types Settings which involves retrieving various request types.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "disclosureTypesName": "string",
  • "disclosureTypesDescription": "string",
  • "disclosureTypesCategories": [
    ],
  • "disclosureTypesStatus": true,
  • "disclosureTypeDisplayOrder": 0,
  • "disclosureType": "string",
  • "enableCapturingVentureCapital": true
}

Retrieve notification template

Retrieves notification template data.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "name": "string"
}

Retrieve relation to discloser settings

Retrieves relation to discloser settings for the disclosure of various relationships or affiliations pertaining to the discloser. This process involves retrieving and managing settings that define how various relationships or affiliations of a discloser are disclosed.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "relationtoDiscloser": [
    ]
}

Retrieve disclosure profile settings

Retrieves disclosure profile settings to set different instructions. This process involves accessing and configuring disclosure profile settings to establish various instructions or guidelines.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "daysSponsoredTravelRemainsActive": 0,
  • "disclosureProfileInstructionsAndPolicy": "string",
  • "foreignInfluenceAttestation": "string",
  • "completeDisclosureProfileUpdateActivityAttestation": "string"
}

Retrieve SmartForm Flex

Retrieves added custom fields to SmartForms.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "daysSponsoredTravelRemainsActive": 0,
  • "disclosureProfileInstructionsAndPolicy": "string",
  • "foreignInfluenceAttestation": "string",
  • "completeDisclosureProfileUpdateActivityAttestation": "string"
}

Retrieve event types

Retrieve event types for triggering event. This process involves retrieving specific event types that can trigger event.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "relationtoDiscloser": [
    ]
}

Retrieve in-kind support types

Retrieves in-kind support types for discloser type in-kind support. This process involves retrieving various types of in-kind support that a discloser may receive or provide.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "inKindSupport": [
    ]
}

Retrieve certification types

Retrieves certification types used to define certification for a research project. This process involves retrieving and categorizing different types of certifications that can be applied to define the certification status of a research project.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "certificationTypes": [
    ]
}

Retrieve COI Categories

Retrieves COI Categories for certifications. This process involves retrieving and categorizing COI categories specifically relevant to certifications.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve SmartForm Steps

Retrieve a list of SmartForm Steps applicable for COI SmartForms. This process involves retrieving a comprehensive list of SmartForm Steps specifically designed and applicable for COI SmartForms.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": {
    },
  • "data": [
    ],
  • "links": {
    }
}

Retrieve SmartForm Step

Retrieves a SmartForm Step with the provided step ID.

Authorizations:
tokenAuthorizer
path Parameters
id
required
string

Unique Step ID.

Responses

Response samples

Content type
application/json
{
  • "stepId": 0,
  • "id": 0,
  • "title": "string",
  • "displayOrder": 0,
  • "projectType": "string",
  • "categories": [
    ],
  • "active": true,
  • "showToAllDisclosers": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "categoriesNames": "string"
}

Update specified SmartForm Step

Updates partial data in specified SmartForm Step record specified by the ID to reflect values included in the request body, which includes certain properties in appropriate JSON format. Fields with dependencies are still validated, even though those fields are not in the request body.

This operation is idempotent (i.e., if it is submitted multiple times, it will have the same effect as it did the first time).

Authorizations:
tokenAuthorizer
path Parameters
id
required
string

Unique Step ID.

Request Body schema: application/json
required

A JSON object including partial fields

stepId
integer

Unique ID of the SmartForm step.

id
integer

Unique ID of the SmartForm step for database reference.

title
string

Title of the SmartForm step.

displayOrder
number

Display order of the SmartForm step (e.g., 1,2).

projectType
string

Type of COI project to which the step is assigned (e.g., Disclosure Profile, Management Plan, Retrospective Review, Triggering Event, Pre Approval Request).

Array of objects (COISettingsCOICategories) [ items ]

List of active Categories to which step is assigned. This setting option will display only if ShowToAllDisclosers is set to False.

active
boolean

Indicates whether the step is active. The values are true or false.

showToAllDisclosers
boolean

Indicates whether the step is shown to all disclosers. The values are true or false.

NOTE: This field is applicable only to disclosure profile and Pre-Approval Request project types.

dateCreated
string <date-time>

The timestamp when the category was created.

dateModified
string <date-time>

The timestamp when the category was last updated.

categoriesNames
string

Name of the categories to which step is assigned.

Responses

Request samples

Content type
application/json
{
  • "stepId": 0,
  • "id": 0,
  • "title": "string",
  • "displayOrder": 0,
  • "projectType": "string",
  • "categories": [
    ],
  • "active": true,
  • "showToAllDisclosers": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "categoriesNames": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Disclosure Profile

A disclosure profile is a project or record that tracks the discloser’s interests and training status. COI Administrators (COIAs) create a disclosure profile for individuals who need to disclose a conflict of interest that might affect the integrity of research studies at their institution.

Remove training tasks

Removes complete COI training tasks for the inactivated categories.

Authorizations:
tokenAuthorizer
path Parameters
action
required
string
Example: RemoveTrainingTasks

Action ID of the action that needs to be executed.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
object (RemoveTrainingTasks)

Central Action Activity Data.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List disclosure profiles

Returns a list of disclosure profiles. It supports query parameters for filtering and pagination. If no query parameter(s) is specified, all the disclosure profiles will be returned.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve disclosure profile by HRN for certification SmartForm

Retrieves a disclosure profile based on HRN for certification SmartForm.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:26

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieve disclosure profile by HRN

Retrieves a disclosure profile based on HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:26

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update specified disclosure profile

Updates partial data in disclosure profile record specified by the HRN to reflect values included in the request body, which includes certain properties in appropriate JSON format. Fields with dependencies are still validated, even though those fields are not in the request body.

This operation is idempotent (i.e., if it is submitted multiple times, it will have the same effect as it did the first time).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:26

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Request Body schema: application/json
required

A JSON object including partial fields

object (TrainingAcknowledgement)

Acknowledgement of training material by the discloser including form step responses.

object (UpdateDisclosureProfile)
object (AdditionalDisclosureDetails)

Additional disclosure details related to foreign talent programs and startup affiliations.

object

Custom key-value data associated with the disclosure.

Array of objects

Step-by-step form data filled during the disclosure process.

Responses

Request samples

Content type
application/json
{
  • "instructionsAndPolicies": {
    },
  • "disclosuresAndRequestInfo": {
    },
  • "additionalInformation": {
    },
  • "customProperties": { },
  • "stepFormData": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve Persons requiring profile

Retrieves Persons requiring profile.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve Persons Profile

Retrieves Persons having Profile.

Authorizations:
tokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve disclosure profile by Person HRN

Retrieves a disclosure profile based on Person HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Retrieve disclosure's Person HRNs by Proxy HRN

Retrieves disclosure's Person HRNs by Proxy HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:26

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List active disclosures

Returns a list of active disclosures.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve active items

Retrieves active items.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:5

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "item": "string",
  • "hrn": "string"
}

List disclosure types by entity

Returns a list of disclosure types by entity.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:5

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

entity
required
string
Example: hrn:hrs:orgs:5

HRN of the organization (e.g., hrn:hrs:orgs:30) or Name of write-in entity (e.g., Abbott Laboratories).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List snapshots

Returns a list of snapshots.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:5

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{}

Update disclosure profile activity state

Updates the disclosure profile activity state record as specified in the request body.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:26

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

action
required
string
Enum: "DeactivateDisclosureProfile" "ReactivateDisclosureProfile" "ApplyTag" "RemoveTag" "CompleteProxyUpdate" "ManageProxy" "CompleteDisclosureProfileUpdate" "ReviewManagementPlans" "ReviewRequestedClarifications"
Example: deactivatedisclosureprofile

Action to be performed on disclosure profile.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
reasonForDeactivation
required
string

Text describing the reason for deactivating the profile.

Array of objects (DocumentRef)

An array of supporting documents.

Array of objects

Metadata describing how the deactivation form fields are displayed.

customProperties
object or null

Any custom properties tied to the deactivation event.

Responses

Request samples

Content type
application/json
Example
{
  • "reasonForDeactivation": "Profile no longer relevant due to departure from institution.",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ],
  • "customProperties": { }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List active Disclosures Requires Profile update

Returns a list of active Disclosures Requires Profile update.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List inactive disclosures

Returns a list of inactive disclosures.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Retrieve actions for action log

Retrieves actions for action log by project hrn and its accessibility to the user for disclosure profile.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:59

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List Write-In Entities

Returns a list of Write-In Entities.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List disclosure entities

Returns a list of disclosure entities.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:26

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List disclosure entities by type

Returns a list of disclosure entities based on disclosure type.

Authorizations:
tokenAuthorizer
path Parameters
personHrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:4596

HRN of the person.

disclosureType
required
string
Example: Prizes

The type of the disclosure.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Retrieve disclosure information

Retrieves additional details of disclosure profile (e.g., Training last Completed date, Disclosure Status, Disclosure profile last completed date).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "trainingLastCompletedDate": "2019-08-24T14:15:22Z",
  • "disclosureStatus": "string",
  • "disclosureProfileLastCompletedDate": "2019-08-24T14:15:22Z"
}

List disclosure profile change log

Returns a list of disclosure profile change log.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:5

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Migrate a disclosure profile from v10 to v12

Migrates a disclosure profile along with disclosure entities , smart form fields from v10 to v12

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
discloserId
required
string

Discloser ID of a profile that needs to migrate.

name
required
string <= 255 characters

Name of the discloser profile.

required
object

To migrate only mention the HRN of person.

object

To migrate only mention the HRN of person.

hasAcceptedTrainingMaterials
boolean

Indicates whether the discloser has accepted training materials in the disclosure profile. The values are true or false.

hasOutsideActivities
boolean

Indicates whether the discloser has any outside activities or financial interests to disclose. The values are true or false. If Outside Activities is set to true then, disclosureEntities needs to be migrated.

isActive
boolean

Indicates whether the profile migrated is active. The values are true or false.

dateCreated
required
string <date-time>

The timestamp when the profile was created, in UTC format.

dateModified
string <date-time>

Date on which profile was modified.

submittedDate
string <date-time>

Date on which profile was submitted.

trainingExpirationDate
string <date-time>

Date on which training has been expired.

projectStateId
required
string

The state of the disclosure profile (Active | InActive | ActionRequired | NoActionRequired).

previousProjectStateId
string

Previous project state ID.

workflowState
required
string

The disclosure profile's current state.

createdBy
required
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

modifiedBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

Array of objects (UpdateDisclosureEntity)

Responses

Request samples

Content type
application/json
{
  • "discloserId": "string",
  • "name": "string",
  • "discloser": {
    },
  • "discloserProxy": {
    },
  • "hasAcceptedTrainingMaterials": true,
  • "hasOutsideActivities": true,
  • "isActive": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "submittedDate": "2019-08-24T14:15:22Z",
  • "trainingExpirationDate": "2019-08-24T14:15:22Z",
  • "projectStateId": "string",
  • "previousProjectStateId": "string",
  • "workflowState": "string",
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "disclosureEntities": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Create Disclosure Profile Import

NOTE: THIS IS MAINLY USED FOR MIGRATION OF LEGACY DATA.

Creates the disclosure record as specified in the request body, and returns system generated identifier Disclosure ID.

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects

Responses

Request samples

Content type
application/json
{
  • "idFieldName": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

List requested clarifications

Returns a list of requested clarifications.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureprofile:[0-9]+$
Example: hrn:hrs:disclosureprofile:5

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

List Person by roles

Returns a list of Person based on roles.

Authorizations:
tokenAuthorizer
path Parameters
roles
required
string
Example: COI-Administrator,COI-General-User

Roles assigned to the person.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List disclosure profiles with outstanding portfolio reviews

Returns a list of disclosure profiles with outstanding portfolio reviews. It supports query parameters for filtering and pagination. If no query parameter(s) is specified, all the disclosure profiles with outstanding portfolio reviews will be returned.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Disclosure Entity

Use the Disclosure Entity object to update the data in specified Disclosure Entity.

Update Disclosure Entity Deprecated

Updates partial data in a specified Disclosure Entity.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:disclosureentity:[0-9]+$
Example: hrn:hrs:disclosureentity:5

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Request Body schema: application/json
optional

A JSON object including partial fields

hrn
required
string^hrn:hrs:discloserentity:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

disclosureEntityId
integer

ID of the disclosure entity record.

entityId
string <uuid>

The unique identifier of the entity. This contains UUID to represent a record uniquely.

profileId
integer

ID of the disclosure entity profile associated with the disclosure entity.

object^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object

Custom write-in entity information (if any).

object

Details of the organization/entity.

dateCreated
string

Date when the entity disclosure was created.

dateModified
string

Date when the entity disclosure was last modified.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

totalValue
integer

The total value of all disclosures for an entity entered by the disclosure.

totalDuration
integer

The total duration of all disclosed activities for an entered by the discloser.

entitySource
string

Represents where an entity source is created from i.e., a Disclosure Profile or Pre-approval request.

disclosureTypeId
string

ID of the disclosure type (e.g., Equity, Travel).

customProperties
object

Custom properties or additional fields.

isDeleted
boolean

Indicates whether the disclosure entity has been marked as deleted. The values are true or false.

Array of objects

Data collected from the custom disclosure form.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object

Status and classification of the entity.

required
Equity (object) or Editorial (object) or Consulting (object) or IP (object) or Divestiture (object) or Travel (object) or Prizes (object) or Other (object) or External (object) or VentureCapital (object) or Board (object) or VisitingScholar (object) or InKind (object)

Denotes compensation properties of a request type.

hasDollarThresholdExceeded
boolean

Indicates whether compensation exceeds threshold. The values are true or false.

hasTimeThresholdExceeded
boolean

Indicates whether time involvement exceeds threshold. The values are true or false.

createdAt
string <date-time>

The time stamp when entity was created. \n\n NOTE: Required for migration.

modifiedAt
string <date-time>

The time stamp when entity was modified.

hasThresholdExceeded
boolean

Indicates whether any of the threshold is exceeded. The values are true or false.

isMpAssociated
boolean

Indicates whether this entity is linked to a management plan. The values are true or false.

requestid
integer

Unique ID related to workflow. This is an Optional field.

isParApproved
boolean

Indicates whether the disclosure is PAR approved. The values are true or false.

Responses

Request samples

Content type
application/json
{
  • "hrn": "string",
  • "disclosureEntityId": 0,
  • "entityId": "49e54b25-882b-45cc-8a2f-819cca78b40f",
  • "profileId": 25,
  • "entityHrn": {
    },
  • "writeInEntity": {
    },
  • "entityDetail": {
    },
  • "dateCreated": "2025-05-08T15:52:49.0000000Z",
  • "dateModified": "2025-05-08T15:52:49.0000000Z",
  • "createdBy": {
    },
  • "totalValue": 22,
  • "totalDuration": 0,
  • "entitySource": "string",
  • "disclosureTypeId": "VisitingScholar",
  • "customProperties": {
    },
  • "isDeleted": false,
  • "formData": [
    ],
  • "personHrn": {
    },
  • "entityInformation": {
    },
  • "compensation": {
    },
  • "hasDollarThresholdExceeded": false,
  • "hasTimeThresholdExceeded": false,
  • "createdAt": "2025-05-31T10:00:00.000Z",
  • "modifiedAt": "2025-05-31T10:00:00.000Z",
  • "hasThresholdExceeded": false,
  • "isMpAssociated": false,
  • "requestid": 0,
  • "isParApproved": false
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string",
  • "code": 0,
  • "links": {
    }
}

Person Extended

Use Person Extended object to manage COI-specific data that relates to any Persons’ record.

Retrieve person details

Retrieves a JSON object representing the external personnel record specified by the HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "personhrn": "string",
  • "paymentId": "string"
}

Update extended person information

Updates partial data in extended person's record specified by the person's HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Request Body schema: application/json
optional

A JSON object including partial fields

object (PersonExtended)

Responses

Request samples

Content type
application/json
{
  • "personExtendedData": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Import

Bulk Import Persons

Imports a person record as specified in the request body to create disclosure profile and assign the person to a category (if needed),and returns the HRN (Huron Resource Name).

This operation is not idempotent (i.e., if it is executed multiple times, it will create multiple records, and return a different HRN for each one).

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects

Responses

Request samples

Content type
application/json
{
  • "idFieldName": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ]
]

Bulk Import organizations

Imports an organization record as specified in the request body and returns the HRN (Huron Resource Name).

This operation is not idempotent (i.e., if it is executed multiple times, it will create multiple records, and return a different HRN for each one).

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects

Responses

Request samples

Content type
application/json
{
  • "idFieldName": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ]
]

Organization Extended

Use Organization Extended object to manage COI-specific data that relates to any organizations’ records.

Retrieve organization details

Retrieves a JSON object representing the extended organization record specified by the HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:orgs:[0-9]+$
Example: hrn:hrs:orgs:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "organizationHrn": {
    },
  • "defaultReviewerHrn": {
    },
  • "reviewers": [
    ]
}

Update organization information

Updates partial data in specified extended organization's record specified by the organization's HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:orgs:[0-9]+$
Example: hrn:hrs:orgs:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Request Body schema: application/json
optional

A JSON object including partial fields

object^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (PersonRef)

Responses

Request samples

Content type
application/json
{
  • "organizationHrn": {
    },
  • "defaultReviewerHrn": {
    },
  • "reviewers": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Pre Approval Request

A Pre Approval Request is a project or record that tracks the PAR.

List pre approval requests

Returns a list of pre approval requests.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": {
    },
  • "data": [
    ],
  • "links": {
    }
}

Create pre approval request

Creates the pre approval request record as specified in the request body, and returns system generated identifier request ID.

This operation is not idempotent (i.e., if it is executed multiple times, it will create multiple records, and return a different note ID for each one).

Authorizations:
tokenAuthorizer
Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

hrn
string^hrn:hrs:preapprovalrequest:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

id
string <= 155 characters

The ID of the pre approval request record.

name
required
string <= 255 characters

The title of the pre approval request provided at creation.

requestor
required
string

The requestor type of string which contain person hrn of the selected requestor.

required
object^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

requestTypes
required
Array of strings
Items Enum: "Travel" "Equity" "Board" "Editorial" "Consulting" "IP" "Divestiture" "Prizes" "Other" "External" "VentureCapital" "VisitingScholar" "InKind"

An array of the request types.

Array of objects (WriteInEntity)
Equity (object) or Editorial (object) or Consulting (object) or IP (object) or Divestiture (object) or Travel (object) or Prizes (object) or Other (object) or External (object) or VentureCapital (object) or Board (object) or VisitingScholar (object) or InKind (object)

Compensation properties of a request type.

dateCreated
string <date-time>

The timestamp when the pre approval request was created.

dateModified
string <date-time>

The timestamp when the pre approval request was last modified.

state
string

State of the request.

discloserName
string

Name of the discloser who is selected as a requestor.

homeDepartment
string

Name of the organization for discloser (requestor).

Responses

Request samples

Content type
application/json
{
  • "requestor": "hrn:hrs:persons:1703168",
  • "name": "test_request_name",
  • "entity": "hrn:hrs:orgs:60511",
  • "requestTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "hrn": "string"
}

Update pre approval request activity state

Updates the pre approval request activity state record as specified in the request body. This creates activity logs.

This operation is not idempotent (i.e., if it is executed multiple times, it will return an error for invalid state transition unless the activity has no state transition).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:preapprovalrequest:[0-9]+$
Example: hrn:hrs:preapprovalrequest:1

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

action
required
string
Enum: "SubmitRequest" "ApplyTag" "RemoveTag"
Example: submitrequest

Action to be performed on the pre approval request.

Request Body schema: application/json
required

A JSON object that contains values for required and optional fields

One of
comments
required
string

Extra information passed at the time of submitting request.

Array of objects (DocumentRef)

An array of supporting documents.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

Responses

Request samples

Content type
application/json
{
  • "comments": "adds",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Retrieve pre approval request variable (IS_PAR_ENABLED) status

Retrieves the pre approval request status.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "IS_PAR_ENABLED": "string"
}

Retrieve actions for action log

Retrieves actions for action log by project hrn and its accessibility to the user for pre approval request.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:preapprovalrequest:[0-9]+$
Example: hrn:hrs:preapprovalrequest:845

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "actionId": "string"
}

Retrieve pre approval request

Retrieves the pre approval request based on HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:preapprovalrequest:[0-9]+$
Example: hrn:hrs:preapprovalrequest:1

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": {
    },
  • "data": [
    ],
  • "links": {
    }
}

Update Pre Approval Request

Updates partial data in specified a pre approval request record specified by the HRN to reflect values included in the request body, which includes certain properties in appropriate JSON format. Fields with dependencies are still validated, even though those fields are not in the request body.

This operation is idempotent (i.e., if it is submitted multiple times, it will have the same effect as it did the first time).

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:preapprovalrequest:[0-9]+$
Example: hrn:hrs:preapprovalrequest:1

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Request Body schema: application/json
required

A JSON object including partial fields

hrn
string^hrn:hrs:preapprovalrequest:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

id
string <= 155 characters

The ID of the pre approval request record.

name
required
string <= 255 characters

The title of the pre approval request provided at creation.

requestor
required
string

The requestor type of string which contain person hrn of the selected requestor.

required
object^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

requestTypes
required
Array of strings
Items Enum: "Travel" "Equity" "Board" "Editorial" "Consulting" "IP" "Divestiture" "Prizes" "Other" "External" "VentureCapital" "VisitingScholar" "InKind"

An array of the request types.

Array of objects (WriteInEntity)
Equity (object) or Editorial (object) or Consulting (object) or IP (object) or Divestiture (object) or Travel (object) or Prizes (object) or Other (object) or External (object) or VentureCapital (object) or Board (object) or VisitingScholar (object) or InKind (object)

Compensation properties of a request type.

dateCreated
string <date-time>

The timestamp when the pre approval request was created.

dateModified
string <date-time>

The timestamp when the pre approval request was last modified.

state
string

State of the request.

discloserName
string

Name of the discloser who is selected as a requestor.

homeDepartment
string

Name of the organization for discloser (requestor).

Responses

Request samples

Content type
application/json
{
  • "id": "1",
  • "requestor": "hrn:hrs:persons:1703168",
  • "name": "test_request_name",
  • "entity": "hrn:hrs:orgs:60511",
  • "requestTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "detail": "string",
  • "code": 0,
  • "links": {
    }
}

Retrieve review information of requests

Retrieves review information of requests based on HRN.

Authorizations:
tokenAuthorizer
path Parameters
hrn
required
string^hrn:hrs:preapprovalrequest:[0-9]+$
Example: hrn:hrs:preapprovalrequest:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Adhoc Agenda Projects

Use Adhoc Agenda Projects object to collect all the project type related details.

List projects

Returns individual COI projects assigned to meetings used to show in the Committee area as agenda items. If no query parameter(s) is specified, all project types will be returned.

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "filters": {
    },
  • "data": [
    ],
  • "links": {
    }
}

Retrieve certification details

Retrieves partial certification details based on the query parameter filter=filter[hrn]=in:certificationhrn. HRN of the certification record (e.g., hrn:hrs:certification:5356).

Authorizations:
tokenAuthorizer
query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{
  • "hrn": "string",
  • "displayId": "string",
  • "name": "string",
  • "status": "string",
  • "assignedReviewer": {
    },
  • "submitCommitteeReviewActionLink": "string",
  • "projectType": "string",
  • "determination": {
    },
  • "isReviewed": true
}

CORS

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. Implementation of this standard in the Conflict of Interest API allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:retrospectivereview:[0-9]+$
Example: hrn:hrs:retrospectivereview:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:retrospectivereview:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:retrospectivereview:[0-9]+$
Example: hrn:hrs:retrospectivereview:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:retrospectivereview:resource_id.

action
required
string
Enum: "SubmitRetrospectiveReview" "SubmitMitigationPlan" "Comment" "AssignReviewer" "Discard" "BypassAncillaryBlock"
Example: SubmitRetrospectiveReview

Action to be performed on the Project.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:retrospectivereview:[0-9]+$
Example: hrn:hrs:retrospectivereview:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:retrospectivereview:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:preapprovalrequest:[0-9]+$
Example: hrn:hrs:preapprovalrequest:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:triggeringevent::[0-9]+$
Example: hrn:hrs:triggeringevent:104

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:triggeringevent:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:371

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:371

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
state
required
string

State of the certification (e.g., AwaitingProfileUpdate).

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

action
required
string
Enum: "AssignReviewer" "SubmitMyReview" "SubmitReview" "ResetReviewStages" "ApplyTag" "RemoveTag" "ReturnForReview" "AssignToCommitteeReview" "Withdraw" "RequestClarification" "ManageClarification" "SCRReview" "ReassignManagementPlan" "AssignToMeeting" "RemoveFromAgenda"
Example: assignreviewer

Action ID of a particular action.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
researchProjectId
required
string

Unique ID of the research project.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:managementplan:[0-9]+$
Example: hrn:hrs:managementplan:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:certification:[0-9]+$
Example: hrn:hrs:certification:16

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:persons:resource_id.

query Parameters
object

Indicates pagination support.

filter
string
Example: filter=filter[0!firstName!and]=eq:Peter

The field name to filter the items.

Filter, in the format:

filter[priority!fieldname!logicalOperator]=comparisonOperator:value

  • priority—integer value indicating the sequence in which the filters should be applied
  • fieldName—filterable field name
  • logicalOperator—one of the following:
    • or—Or
    • and—And
  • comparisonOperator—one of the following:
    • eq—Equal to
    • neq—Not equal
    • lt—Less than
    • lte—Less than or equal to
    • gte—Greater than or equal to
    • null—Is null
    • in—In matches any value in the specified list
  • value—The value to compare

Note: To add multiple filters, include multiple instances of this query parameter, with the priority set.

sort
string
Default: "dateModified"
Example: sort=id

The field name to sort the items. The default sort order is descending.

Note: To specify ascending sort order, prefix the field name with a dash (e.g. "-dateModified").

include
string
Example: include=name, id, shortTitle

The list of fields of the resource record to include in the response. If this parameter is omitted, all the fields are returned. To add multiple fields, use a comma separator (,).

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
action
required
string
Enum: "managecategorypersonnelbulkprocess" "reactivatedisclosureprofiles" "CreateDisclosureProfileBulkProcess" "deactivatedisclosureprofiles" "ManageEligibleProxies" "ManageProxyAssignments" "AdminOffices" "managewriteinentities"
Example: ManageEligibleProxies

Action ID.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
action
required
string
Example: manage-category-personnel, expire-training

Central Actions action ID.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
action
required
string
Example: manage-category-personnel, expire-training

Central Actions action ID.

status
required
string

Status of the action.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
category
required
string
Example: Research, nonresearch1

Category Id. To add multiple categories, use a comma-separator (,).

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

query Parameters
profileHrn
string

Huron Resource Name (HRN) of the profile.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:persons:[0-9]+$
Example: hrn:hrs:persons:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

path Parameters
hrn
required
string^hrn:hrs:orgs:[0-9]+$
Example: hrn:hrs:orgs:18

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

CORS support

Enable CORS (Cross-Origin Resource Sharing) by returning correct headers to support data transfers between browsers and servers, even if requests originate from different domains.

Responses

Response samples

Content type
application/json
{ }

All Models

AssignReviewer

required
object (MigrateOrImportPersonHrn) ^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

customProperties
object

Custom properties or additional fields.

{
  • "reviewer": {
    },
  • "actionLogFormData": [
    ],
  • "customProperties": {
    }
}

AssignPlanCreator

required
object

Details about the plan creator.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "planCreator": {
    },
  • "actionLogFormData": [
    ]
}

AllProjectResponse

name
string

Name of the project.

modifiedDate
string <date-time>

The timestamp when the project was last modified.

status
string

Status of the project (e.g., ActionRequired, InReview).

displayId
string

Unique ID of the project type generated at creation.

projectType
string

Type of the COI project (e.g., COIMANAGEMENTPLAN, COICERTIFICATIONS).

object

Details of the Principal Investigator (PI) assigned to the project.

{
  • "name": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "displayId": "string",
  • "projectType": "string",
  • "pI": {
    }
}

AllProjectListResponse

object (Pagination)

Describes pagination support.

object
Array of objects (AllProjectResponse)
object
{
  • "pagination": {
    },
  • "filters": {
    },
  • "data": [
    ],
  • "links": {
    }
}

AgendaItemResponse

hrn
string (HRN)

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

displayId
string

Unique ID of the certification project type generated at creation.

name
string

Name of the certification.

status
string

Status of the certification (e.g., ReviewComplete, Withdrawn).

object

Details of the assigned reviewer.

submitCommitteeReviewActionLink
string

URL of the submit committee review action.

projectType
string

Type of the COI project (e.g., Coi_Certification).

object

The determination selected for the certification by the final reviewer. Determination contains (hrn:hrs:lists:coi-review-determination-list/interests-not-related | hrn:hrs:lists:coi-review-determination-list/interests-no-conflict | hrn:hrs:lists:coi-review-determination-list/interests-and-conflict-management-plan-required`).

isReviewed
boolean

Indicates whether the certification is reviewed. The values are true or false.

{
  • "hrn": "string",
  • "displayId": "string",
  • "name": "string",
  • "status": "string",
  • "assignedReviewer": {
    },
  • "submitCommitteeReviewActionLink": "string",
  • "projectType": "string",
  • "determination": {
    },
  • "isReviewed": true
}

AdminOfficesListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (AdminOfficesListResponseObject)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

AssignMonitors

Array of objects (PersonRef)

The details of the plan monitors associated with the management plan.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "planMonitors": [
    ],
  • "actionLogFormData": [
    ]
}

AdminOffices

object

Details of the person assigned as the administrative backup reviewer for all the offices.

Array of objects (AdminOffice)

Details of the admin office.

Array of objects (actionLogFormData)

Metadata about the form fields shown in the action log interface.

{
  • "administrativeBackupReviewer": {
    },
  • "adminOffices": [
    ],
  • "actionLogFormData": [
    ]
}

AssignToMeeting

Array of objects

List of metadata describing various meeting-related fields and their values.

object^hrn:hrs:lists:agenda-item-types/[a-z0-9-]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

relatedProjectHrn
string^hrn:hrs:certification:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

displayOrder
integer

Order in which the meeting or agenda item is displayed.

meetingHrn
string

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

committeeHrn
string^hrn:hrs:committees:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

meetingName
string

Name of the meeting.

{
  • "actionLogFormData": [
    ],
  • "agendaTypeHrn": {
    },
  • "relatedProjectHrn": "string",
  • "displayOrder": 1,
  • "meetingHrn": "hrn:hrs:meetings:8554",
  • "committeeHrn": "hrn:hrs:committees:1",
  • "meetingName": "0907 2 meeting on 4/12/2025 12:00 AM"
}

AdminOffice

name
required
string

The name of the office.

object

Information of the person assigned as the default reviewer for the office.

required
Array of objects (PersonRef)

Staff data associated with the COI office.

isActive
required
boolean

Indicates whether an office is available for selection. The values are true or false.

{
  • "name": "string",
  • "defaultReviewer": {
    },
  • "staff": [
    ],
  • "isActive": true
}

ApplyTag

object^hrn:hrs:lists:tags/[a-z0-9-]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

name
string

Name of the tag on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "hrn": {
    },
  • "name": "string",
  • "actionLogFormData": [
    ]
}

AdminOfficesOfCurrentUserResponse

resourceType
string
actions
Array of strings
adminOffices
Array of strings
{
  • "resourceType": "string",
  • "actions": [
    ],
  • "adminOffices": [
    ]
}

AssignToCommitteeReview

notes
string

Notes entered on action performed.

isAssignToMeeting
boolean

Indicates whether the meeting is assigned. The values are Yes or No.

object^hrn:hrs:lists:agenda-item-types/[a-z0-9-]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

relatedProjectHrn
string

HRN of the related certification.

displayOrder
integer

Order entered on action performed.

object^hrn:hrs:meeting:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

committeeHrn
string^hrn:hrs:committees:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

Array of objects (DocumentRef)

Documents entered on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "notes": "string",
  • "isAssignToMeeting": true,
  • "agendaTypeHrn": {
    },
  • "relatedProjectHrn": "string",
  • "displayOrder": 0,
  • "meetingHrn": {
    },
  • "committeeHrn": "hrn:hrs:committees:1",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ]
}

AssignCoordinator

required
object

A single selection person chooser in which we select the coordinator.

comments
string

Comment on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "coordinator": {
    },
  • "comments": "string",
  • "actionLogFormData": [
    ]
}

AdminOfficesListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (AdminOfficesListResponseObject)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

ActiveItemsDisclosure

item
string

Project items.

hrn
string (HRN)

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

{
  • "item": "string",
  • "hrn": "string"
}

ActiveDisclosure

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (ActiveDisclosureList)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

ByPassAncillaryBlock

isBypass
required
boolean

Indicates whether an ancillary review was bypassed on the retrospective review. The values are true or false. If set to TRUE, user can add value for the "bypassReason" field.

byPassReason
required
string

The reason an ancillary review block was bypassed for a retrospective review.

customProperties
object

Custom properties or additional fields.

{
  • "isBypass": true,
  • "byPassReason": "lorem ipsum reason",
  • "customProperties": {
    }
}

BulkImportOrganizationExtended

organizationId
string

ID of the organization.

defaultReviewerId
string

ID of the person assigned as the default reviewer.

reviewers
Array of strings

List of person Ids assigned as reviewers.

{
  • "organizationId": "string",
  • "defaultReviewerId": "string",
  • "reviewers": [
    ]
}

BulkImportCertification

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects
{
  • "idFieldName": "string",
  • "data": [
    ]
}

BulkImportOrganizations

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects
{
  • "idFieldName": "string",
  • "data": [
    ]
}

BulkImportPersons

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects
{
  • "idFieldName": "string",
  • "data": [
    ]
}

COIExtendedPersonsForBulkImport

personId
string

ID field of the person.

categoryName
string

Name of the category for which the person is to be added.

categoryId
string

Unique ID associated with the category for which the person is to be added.

isRemoveCategory
string
Enum: "True" "Yes"

Indicates that the given person should be removed from the specified category when value is true or yes.

{
  • "personId": "string",
  • "categoryName": "string",
  • "categoryId": "string",
  • "isRemoveCategory": "True"
}

COIExtendedOrganizationForBulkImport

organizationId
required
string

ID of the organization.

defaultReviewerId
string

ID of the person assigned as the default reviewer.

reviewers
Array of strings

List of person Ids assigned as reviewers.

{
  • "organizationId": "string",
  • "defaultReviewerId": "string",
  • "reviewers": [
    ]
}

ClarificationListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (ClarificationResponse)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

CertificationToReassign

hrn
string (HRN)

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

name
string

Name of the Certification.

conflicts
Array of strings

Describes the conflicts.

entities
Array of strings

Describes the entities.

{
  • "hrn": "string",
  • "name": "string",
  • "conflicts": [
    ],
  • "entities": [
    ]
}

ClarificationResponse

clarificationId
integer

Unique ID when clarification is requested.

certificationId
integer

ID of the certification record at creation.

requestText
string

Text entered when the clarification was requested.

Array of objects (DocumentRef)

An array of supporting documents.

requestDate
string <date-time>

The timestamp when the clarification was requested.

dateCreated
string <date-time>

The timestamp when the clarification request date was created.

object

Details of the requestor.

descriptionDetails
Array of strings

Specific details added to the description.

certId
string

Unique ID of the Certification.

responseSubmitted
boolean

Indicates whether the response to the clarification has been submitted. The values are true or false.

{
  • "clarificationId": 0,
  • "certificationId": 0,
  • "requestText": "string",
  • "supportingDocuments": [
    ],
  • "requestDate": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "requestor": {
    },
  • "descriptionDetails": [
    ],
  • "certId": "string",
  • "responseSubmitted": false
}

CentralActionsExecutionStatusResponse

status
string

Status of the execution response (e.g., SUCCEEDED).

executionArn
string [ 1 .. 256 ] characters

Amazon resource name (ARN) that identifies the execution (e.g., arn:aws:states:us-east-2:867227410828:execution:hrs-appsdev-CoiCentralActions-StepFunction:5d57fab8-a27d-4854-8af0-6a162042a9a3).

{
  • "status": "string",
  • "executionArn": "string"
}

CentralActionsMPExecutionResponse

object (Pagination)

Describes pagination support.

object
Array of objects (CAManagePersonnelExecutionList)
object
{
  • "pagination": {
    },
  • "filters": {
    },
  • "data": [
    ],
  • "links": {
    }
}

CAManagePersonnelExecutionList

id
integer

ID of the execution status.

actionId
string

Action ID of the action.

executionArn
string [ 1 .. 256 ] characters

Amazon resource name (ARN) that identifies the execution (e.g., arn:aws:states:us-east-2:867227410828:execution:hrs-appsdev-CoiCentralActions-StepFunction:5d57fab8-a27d-4854-8af0-6a162042a9a3).

dateCreated
string <date-time>

The timestamp when the execution list was created, in UTC format.

{
  • "id": 0,
  • "actionId": "string",
  • "executionArn": "string",
  • "dateCreated": "2019-08-24T14:15:22Z"
}

CAExecutionStatusRecordsList

Array
personName
string

Name of the person.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

[
  • {
    }
]

CategoryDocuments

hrn
required
string (HRN)

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

name
required
string

Name of the document.

url
required
string

The URL of the document (S3 object).

required
object

The category of the document. Can be either of GrantFile or SupportingDocuments.

dateCreated
required
string <date-time>

The timestamp when the latest version of the document was created.

version
required
number

A number signifying how many revisions are done for the document.

fileKey
required
string

The file key to the COI document (S3 object).

documentScanned
required
number

Number of documents that are scanned.

{
  • "hrn": "string",
  • "name": "string",
  • "url": "string",
  • "category": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "version": 0,
  • "fileKey": "string",
  • "documentScanned": 0
}

CloseTriggeringEvent

reason
required
string

The reason for closing the triggering event.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "reason": "string",
  • "actionLogFormData": [
    ]
}

COISettingsCOICategorie

id
string

Identifier of the certification types (e.g., Research).

categoryName
string

The name of the category.

categoryDescription
string

The description of the category.

trainingReqForSmartform
string

Indicates if there is any institution-specific training requirements to the personnel assigned to the category. The values are "Yes", or "No".

trainingTitle
string

The title of the category training.

isApplicableToAll
boolean

Indicates whether this category applies to all personnel. The values are true or false.

isCategoeyActive
boolean

Indicates whether the category is currently used. The values are true or false.

expireTraingForNew
boolean

Indicates whether the training is expired for newly assigned disclosers. The values are true or false.

categorySpecificTrainingValidity
integer

The total number of days till training is valid (e.g., 365).

categorySpecificTrainingText
string

The text for category specific training. Default training text is delivered by Huron COI.

hasRelyOnExternal
boolean

Indicates whether Huron COI internal system relies on an external system/integration to capture last completed training dates.

categoryAttestion
string

The text for category specific attestation statement.

Array of objects (CategoryDocuments)

Category specific training documents.

{
  • "id": "string",
  • "categoryName": "string",
  • "categoryDescription": "string",
  • "trainingReqForSmartform": "string",
  • "trainingTitle": "string",
  • "isApplicableToAll": true,
  • "isCategoeyActive": true,
  • "expireTraingForNew": true,
  • "categorySpecificTrainingValidity": 0,
  • "categorySpecificTrainingText": "string",
  • "hasRelyOnExternal": true,
  • "categoryAttestion": "string",
  • "categoryDocument": [
    ]
}

COISettingsCOICategories

Array
id
string

Identifier of the certification types (e.g., Research).

categoryName
string

The name of the category.

categoryDescription
string

The description of the category.

trainingReqForSmartform
string

Indicates if there is any institution-specific training requirements to the personnel assigned to the category. The values are "Yes", or "No".

trainingTitle
string

The title of the category training.

isApplicableToAll
boolean

Indicates whether this category applies to all personnel. The values are true or false.

isCategoeyActive
boolean

Indicates whether the category is currently used. The values are true or false.

expireTraingForNew
boolean

Indicates whether the training is expired for newly assigned disclosers. The values are true or false.

categorySpecificTrainingValidity
integer

The total number of days till training is valid (e.g., 365).

categorySpecificTrainingText
string

The text for category specific training. Default training text is delivered by Huron COI.

hasRelyOnExternal
boolean

Indicates whether Huron COI internal system relies on an external system/integration to capture last completed training dates.

categoryAttestion
string

The text for category specific attestation statement.

Array of objects (CategoryDocuments)

Category specific training documents.

[
  • {
    }
]

ClarificationsData

clarification_id
integer

Clarification ID. This gets created while requesting a clarification.

nextStepRadio
string

The decision related to the clarification (e.g., Resolve/request additional).

Comments
string

Comments entered on the action performed.

Array of objects (DocumentRef)

Information of the documents on the action performed.

{
  • "clarification_id": 0,
  • "nextStepRadio": "string",
  • "Comments": "string",
  • "supportingDocuments": [
    ]
}

Conflict

description
string

Description added on conflict addition.

disclosureEntitiesHrn
Array of strings[^hrn:hrs:discloserentity:[0-9]+$]

Entities HRN taken from disclosure profile.

{
  • "description": "string",
  • "disclosureEntitiesHrn": [
    ]
}

conflicts

sourceIdentifier
required
string

ID of the conflict in a source system.

status
required
string

The status of the conflict.

description
required
string

A description about the conflict.

dateCreated
required
string <date-time>

The timestamp when the conflict was created.

dateModified
string <date-time>

The timestamp when the conflict was last modified.

sourceId
Array of strings

Source ID (Disclosure Entity ID ) is from legacy system (ID00000594).

isSatisfied
required
boolean

Indicates whether the resolution of conflict is satisfied. The values are true or false. To eliminate conflict status, set IsSatisfied to True or else isSatisfied value will be false.

{
  • "sourceIdentifier": "string",
  • "status": "string",
  • "description": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "sourceId": [
    ],
  • "isSatisfied": true
}

Comments

comments
required
string

Extra information about the retrospective review.

Array of objects (DocumentRef)
notifyTo
Array of strings
Items Enum: "AssignReviewer" "COIAdministrator"

Email notification for the COI Administrator or an Assigned Reviewer.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

customProperties
object

Custom properties or additional fields.

{
  • "comments": "string",
  • "supportingDocuments": [
    ],
  • "notifyTo": [
    ],
  • "actionLogFormData": [
    ],
  • "customProperties": {
    }
}

clarification

sourceIdentifier
required
string

ID of the clarification in a source system.

NOTE: For migration, use clarification id from legacy system.

request_text
required
string

Description of changes and the requested information.

Array of objects (DocumentRef)

An array of the requested documents.

request_date
required
string <date-time>

The timestamp when the clarification was requested.

date_created
required
string <date-time>

The timestamp when the clarification request was created.

date_modified
string <date-time>

The timestamp when the clarification request was last modified.

requestor
required
string

Id of the requestor

responseDate
string <date-time>

The timestamp when the clarification was responded.

Array of objects (DocumentRef)

Details of the requested document.

responseText
string

Description about the changes made.

{
  • "sourceIdentifier": "string",
  • "request_text": "string",
  • "request_document": [
    ],
  • "request_date": "2019-08-24T14:15:22Z",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_modified": "2019-08-24T14:15:22Z",
  • "requestor": "string",
  • "responseDate": "2019-08-24T14:15:22Z",
  • "response_document": [
    ],
  • "responseText": "string"
}

CertificationData

name
required
string

Name of certification.

id
string

id of certification.

sourceIdentifier
required
string

Source identifier from legacy system.

researchProjectId
string

Source identifier of the triggering event project.

required
object
project_state
required
string

The state of the certification.

object

Details of the reviewer currently assigned to the certification.

certification_type
required
string

Type of certification (e.g., research).

object

The review stages of the certification (final_review_stage | intermediate_review_stage ).

object

The current review stage of the certification.

customProperties
object or null

Any custom properties tied to the certification.

dateCreated
required
string <date-time>

The timestamp when the certification was created.

dateModified
string <date-time>

The timestamp when the certification was last modified.

clarificationResponseDueDate
string <date-time>

The timestamp when a clarification response is due for the certification.

submittedDate
string <date-time>

The timestamp when the certification was submitted.

management_plan
string

management_plan is the source identifier of management plan.

Array of objects (review)

Information related to review like determination, follow up action, etc.

Array of objects (clarification)

Information about the clarification.

{
  • "name": "string",
  • "id": "string",
  • "sourceIdentifier": "string",
  • "researchProjectId": "string",
  • "discloser": {
    },
  • "project_state": "string",
  • "assigned_reviewer": {
    },
  • "certification_type": "string",
  • "review_stages": {
    },
  • "current_review_stage": {
    },
  • "customProperties": { },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "clarificationResponseDueDate": "2019-08-24T14:15:22Z",
  • "submittedDate": "2019-08-24T14:15:22Z",
  • "management_plan": "string",
  • "review": [
    ],
  • "clarification": [
    ]
}

CertificationDataForBulkImport

id
required
string

Unique identifier of the certification.

name
required
string

Name of certification.

sourceIdentifier
string

Source identifier from legacy system.

object^hrn:hrs:triggeringevent:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

required
object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

project_state
required
string

The state of the certification.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

certification_type
required
string
Enum: "Research" "Non-Research"

Type of certification (e.g., Research).

required
object

The review stages of the certification (final_review_stage | intermediate_review_stage ).

required
object

The current review stage of the certification.

customProperties
object or null

Any custom properties tied to the certification.

dateCreated
string <date-time>

The timestamp when the certification was created.

dateModified
string <date-time>

The timestamp when the certification was last modified.

clarificationResponseDueDate
string <date-time>

The timestamp when a clarification response is due for the certification.

object^hrn:hrs:managementplan:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (ReviewForBulkImport)

Information related to review like determination, follow up action, etc.

Array of objects (ClarificationForBulkImport)

Information about the clarification.

{
  • "id": "string",
  • "name": "string",
  • "sourceIdentifier": "string",
  • "research_project_hrn": {
    },
  • "discloser": {
    },
  • "project_state": "string",
  • "assigned_reviewer": {
    },
  • "certification_type": "Research",
  • "review_stages": {
    },
  • "current_review_stage": {
    },
  • "customProperties": { },
  • "dateCreated": "2025-05-01T10:00:00.000Z",
  • "dateModified": "2025-05-01T10:00:00.000Z",
  • "clarificationResponseDueDate": "2025-05-01T10:00:00.000Z",
  • "management_plan_hrn": {
    },
  • "review": [
    ],
  • "clarification": [
    ]
}

CertificationDataForBulkImportForUpdate

<SchemaDefinition schemaRef="#/components/schemas/CertificationDataForBulkImportForUpdate" />

ClarificationForBulkImport

request_text
required
string

Description of changes and the requested information.

Array of objects[ items^hrn:hrs:documents:[a-z0-9]+$ ]

An array of the requested documents.

request_date
required
string <date-time>

The timestamp when the clarification was requested.

date_created
required
string <date-time>

The timestamp when the clarification request was created.

date_modified
string <date-time>

The timestamp when the clarification request was last modified.

required
object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

response_date
string <date-time>

The timestamp when the clarification was responded.

Array of objects[ items^hrn:hrs:documents:[a-z0-9]+$ ]

Details of the requested document.

response_text
string

Description about the changes made.

response_submitted
required
boolean

Indicates whether the response is submitted. The values are true or false.

clarification_response_due_date
string <date-time>

The timestamp when the clarification is due.

{
  • "request_text": "string",
  • "request_document": [
    ],
  • "request_date": "2019-08-24T14:15:22Z",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_modified": "2019-08-24T14:15:22Z",
  • "requestor": {
    },
  • "response_date": "2019-08-24T14:15:22Z",
  • "response_document": [
    ],
  • "response_text": "string",
  • "response_submitted": true,
  • "clarification_response_due_date": "2019-08-24T14:15:22Z"
}

CertificationPatchData

object (CertificationPatchData)
{ }

coialistresponse

Array of objects (PersonRef)
{
  • "data": [
    ]
}

CertificationsListResponse

Certification

ListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (CertificationListObject)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Certification

hrn
string^hrn:hrs:certification:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

id
string <= 155 characters

ID of the certification record.

object

Details of the disclosure for whom the certification was created.

name
string

Name of the certification.

eventType
string

Type of an event (IRB Submission | Grants JIT).

object (PersonRef)
Array of objects
certificationType
string
Enum: "Research" "Non-Research"

Type of certification (e.g., Research, Non-Research).

{
  • "hrn": "string",
  • "id": "string",
  • "discloser": {
    },
  • "name": "string",
  • "eventType": "string",
  • "principalInvestigator": {
    },
  • "assignedReviewer": [
    ],
  • "certificationType": "Research"
}

Catagory

id
string

Identifier of the categories for the disclosure types (e.g., Research).

{
  • "id": "string"
}

CertificationTypesSettings

Array of objects (CertificationType)

Information about the certification types.

{
  • "certificationTypes": [
    ]
}

CompleteProxyUpdate

comments
string

Extra information added about the update.

Array of objects (DocumentRef)

An array of supporting documents.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

customProperties
object

Any custom properties from the action form.

{
  • "comments": "string",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ],
  • "customProperties": { }
}

CreateCertificationsBulkProcess

required
Array of objects (MigrateOrImportPersonHrn) [ items^hrn:hrs:persons:[0-9]+$ ]

Information about persons.

requiresProfileUpdate
required
boolean

Indicates whether discloser need to update their profile prior to routing Certification for review. The values are true or false.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

certificationTypeIds
required
Array of strings

Certifications type ID's of the selected persons.

disclosersSelectionType
required
string

Information about selection of selected personnel or all personnel.

{
  • "individualDisclosers": [
    ],
  • "requiresProfileUpdate": true,
  • "actionLogFormData": [
    ],
  • "certificationTypeIds": [
    ],
  • "disclosersSelectionType": "string"
}

CategoriesListResponse

Categories

ListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (Categories)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

Categories

categoryName
string

Name of the category from settings.

description
string

Short description of the category.

countOfPersonnel
integer

Indicates the count of personnel for category (e.g., 1786).

appliesTo
string

Disclosure/User applicability to a particular category. AppliesTo can be for all/selected personnel.

id
string <uuid>

UUId representation of Category.

{
  • "categoryName": "string",
  • "description": "string",
  • "countOfPersonnel": 0,
  • "appliesTo": "string",
  • "id": "cb36f6b1-c8c0-49d4-90cd-50187e32c073"
}

CategoryPersonneListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (Personnel)
object
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "data": [
    ],
  • "links": {
    }
}

CreateDisclosureProfileBulkProcess

required
Array of objects (PersonRef)

Information about persons.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "persons": [
    ],
  • "actionLogFormData": [
    ]
}

CertificationType

id
string

Identifier of the certification types (e.g., Research).

certificationTypeName
string

Name of the Certification type (e.g., Research, Non-Research).

certificationTypeDescription
string

Description about certification type.

certificationTypeIsActive
boolean

Indicates whether the certification type is currently used. The values are true or false. By default, COI certification type is Active.

certificationTypedisplayOrder
number

The order of display of the certification type.

reviewWorkflowTemplate
string

Name of the review work flow template attached to each certification type (this is from central action).

allowDefaultTemplateOverride
boolean

Indicates whether to allow default template to override. The values are true or false.

restartReviewWorflow
string

Indicates whether to restart the review process of a certification from the initial stage. The values are true or false. If set to True, a change to the disclosure profile associated with the certification restarts the review workflow from the first stage.

NOTE: This setting is only applicable for certifications that are in the Under Review state.

allowCommitteeReview
string

Indicates whether to allow committee review for this certification type. The values are true or false. If set to True, committee is allowed to review the certification.

certificationTextDisplay
string

Information about certification text that is used in action.

enforceWorkflowStoppage
string

Controls the normal workflow by specifying a workflow stoppage for the certification type. The values are "Yes", or "No". If set to "Yes", ancillary reviews that are marked required and have not been completed prevent the project from moving forward beyond the stoppage state. The ancillary review stoppage will not allow the certification to move to the Review Complete state or the Committee Review state.

associatedCategories
string

The category to which the certification type is associated. By default, the Research certification type is associated with the Research category.

NOTE: A non-research certification type can be associated with either the Research category or any non-research category created by the institution.

requireResearchCertification
string

Indicates if the Research certification is required. The values are "Yes", or "No".

Array of objects (DisclosureTypesDetails)

Details about the disclosure type.

totalDollars
integer

The total dollars spent on all the interests and activities exceed.

totalTimes
integer

The total time spent on all the interests and activities exceed.

isThreshold
string

Indicates if threshold is required. The values are "Yes", or "No".

isFlagAsForeign
string

Indicates if the entity related to the disclosure types is a foreign organization. The values are "Yes", or "No".

sponsoredTravelExceed
string

The threshold value of total dollars ($) and time (days) for all the interests and activities in a disclosure profile.

utilizeResearchPortfolio
string

Indicates whether to enable the utilize Research Portfolio functionality. The values are "Yes", or "No".

researchPortfolioTask
Array of strings

List of scenarios that determine when a Research Portfolio Review Task was created.

whenCertificationCreated
Array of strings

List of scenarios that determine when a new certification was created.

UnknownEquity
string

Indicates if the disclosure profile has an unknown equity. The values are "Yes", or "No".

IntellectualProperty
string

Indicates if the disclosure profile includes any intellectual property. The values are "Yes", or "No".

NonPublicTraded
string

Indicates whether the disclosure profile includes equity for a non-publicly traded company. The values are "Yes", or "No".

isNewCertOnProfileUpdate
boolean

Indicates whether to create new certification on profile update. The values are true or false.

sponsorTravelThreshold
string

The threshold value (in dollars) of the sponsored travel.

timeThresholds
string

The threshold value of total time (in days) for all interests and activities.

dollarThresholds
string

The threshold value of total dollars for all interests and activities.

hasThresholds
boolean

Indicates whether the certification requires review thresholds based on all interests and activities. The values are true or false. If set to True, dollarThresholds, timeThresholds, sponsorTravelThreshold are to be defined.

foreignEntityFlagged
boolean

Indicates whether to flag a foreign entity. The values are true or false. If set to True, the certification for the disclosure profile requires a review.

isReviewRequired
boolean

Indicates whether all certifications require review. The values are true or false. If set to True, the thresholds have no impact and all certifications require review, even if the person has nothing to disclose. If set to False, the criteria for a certification review needs to be defined.

{
  • "id": "string",
  • "certificationTypeName": "string",
  • "certificationTypeDescription": "string",
  • "certificationTypeIsActive": true,
  • "certificationTypedisplayOrder": 0,
  • "reviewWorkflowTemplate": "string",
  • "allowDefaultTemplateOverride": true,
  • "restartReviewWorflow": "string",
  • "allowCommitteeReview": "string",
  • "certificationTextDisplay": "string",
  • "enforceWorkflowStoppage": "string",
  • "associatedCategories": "string",
  • "requireResearchCertification": "string",
  • "disclosureTypeDetails": [
    ],
  • "totalDollars": 0,
  • "totalTimes": 0,
  • "isThreshold": "string",
  • "isFlagAsForeign": "string",
  • "sponsoredTravelExceed": "string",
  • "utilizeResearchPortfolio": "string",
  • "researchPortfolioTask": [
    ],
  • "whenCertificationCreated": [
    ],
  • "UnknownEquity": "string",
  • "IntellectualProperty": "string",
  • "NonPublicTraded": "string",
  • "isNewCertOnProfileUpdate": true,
  • "sponsorTravelThreshold": "string",
  • "timeThresholds": "string",
  • "dollarThresholds": "string",
  • "hasThresholds": true,
  • "foreignEntityFlagged": true,
  • "isReviewRequired": true
}

Discard

comments
required
string

Reason for discarding the retrospective review.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

customProperties
object

Custom properties or additional fields.

{
  • "comments": "string",
  • "actionLogFormData": [
    ],
  • "customProperties": {
    }
}

DisclosureProfileSettings

daysSponsoredTravelRemainsActive
integer

Total number of remaining days of active sponsor travel (e.g., 365 days).

disclosureProfileInstructionsAndPolicy
string

The instructions and policy information to display in the disclosure profile.

foreignInfluenceAttestation
string

The attestation to display if discloser profile has a foreign entity.

completeDisclosureProfileUpdateActivityAttestation
string

The attestation to display while performing submit disclosure profile action.

{
  • "daysSponsoredTravelRemainsActive": 0,
  • "disclosureProfileInstructionsAndPolicy": "string",
  • "foreignInfluenceAttestation": "string",
  • "completeDisclosureProfileUpdateActivityAttestation": "string"
}

DisclosureTypeSettings

id
string

Identifier of the disclosure types (e.g., Equity, Editorial).

disclosureTypesName
string

The disclosure type name that appears in selection list (e.g., Visiting Scholar).

disclosureTypesDescription
string

Description about what the disclosure type reports (e.g., Visiting professor or other scholar who temporarily visits the institution to engage in research and scholarship.).

Array of objects (Catagory)

Defines multiple disclosure categories for the discloser (e.g., Research).

disclosureTypesStatus
boolean

Indicates whether the disclosure type. The values are true or false. Set the value to True to display this disclosure type to users.

disclosureTypeDisplayOrder
number

The order in which the disclosure types are listed (e.g., 1, 2).

disclosureType
string

The type which is defined by default (e.g., standard).

enableCapturingVentureCapital
boolean

Indicates whether the disclosure type captures venture capital information. This field is for Equity disclosure type only. The values are true or false.

{
  • "id": "string",
  • "disclosureTypesName": "string",
  • "disclosureTypesDescription": "string",
  • "disclosureTypesCategories": [
    ],
  • "disclosureTypesStatus": true,
  • "disclosureTypeDisplayOrder": 0,
  • "disclosureType": "string",
  • "enableCapturingVentureCapital": true
}

DisclosureProfileChangeLog

<SchemaDefinition schemaRef="#/components/schemas/DisclosureProfileChangeLog" />

DisclosureEntity

hrn
required
string^hrn:hrs:discloserentity:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

disclosureEntityId
integer

ID of the disclosure entity record.

entityId
string <uuid>

The unique identifier of the entity. This contains UUID to represent a record uniquely.

profileId
integer

ID of the disclosure entity profile associated with the disclosure entity.

object^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object

Custom write-in entity information (if any).

object

Details of the organization/entity.

dateCreated
string

Date when the entity disclosure was created.

dateModified
string

Date when the entity disclosure was last modified.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

totalValue
integer

The total value of all disclosures for an entity entered by the disclosure.

totalDuration
integer

The total duration of all disclosed activities for an entered by the discloser.

entitySource
string

Represents where an entity source is created from i.e., a Disclosure Profile or Pre-approval request.

disclosureTypeId
string

ID of the disclosure type (e.g., Equity, Travel).

customProperties
object

Custom properties or additional fields.

isDeleted
boolean

Indicates whether the disclosure entity has been marked as deleted. The values are true or false.

Array of objects

Data collected from the custom disclosure form.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object

Status and classification of the entity.

required
Equity (object) or Editorial (object) or Consulting (object) or IP (object) or Divestiture (object) or Travel (object) or Prizes (object) or Other (object) or External (object) or VentureCapital (object) or Board (object) or VisitingScholar (object) or InKind (object)

Denotes compensation properties of a request type.

hasDollarThresholdExceeded
boolean

Indicates whether compensation exceeds threshold. The values are true or false.

hasTimeThresholdExceeded
boolean

Indicates whether time involvement exceeds threshold. The values are true or false.

createdAt
string <date-time>

The time stamp when entity was created. \n\n NOTE: Required for migration.

modifiedAt
string <date-time>

The time stamp when entity was modified.

hasThresholdExceeded
boolean

Indicates whether any of the threshold is exceeded. The values are true or false.

isMpAssociated
boolean

Indicates whether this entity is linked to a management plan. The values are true or false.

requestid
integer

Unique ID related to workflow. This is an Optional field.

isParApproved
boolean

Indicates whether the disclosure is PAR approved. The values are true or false.

{
  • "hrn": "string",
  • "disclosureEntityId": 0,
  • "entityId": "49e54b25-882b-45cc-8a2f-819cca78b40f",
  • "profileId": 25,
  • "entityHrn": {
    },
  • "writeInEntity": {
    },
  • "entityDetail": {
    },
  • "dateCreated": "2025-05-08T15:52:49.0000000Z",
  • "dateModified": "2025-05-08T15:52:49.0000000Z",
  • "createdBy": {
    },
  • "totalValue": 22,
  • "totalDuration": 0,
  • "entitySource": "string",
  • "disclosureTypeId": "VisitingScholar",
  • "customProperties": {
    },
  • "isDeleted": false,
  • "formData": [
    ],
  • "personHrn": {
    },
  • "entityInformation": {
    },
  • "compensation": {
    },
  • "hasDollarThresholdExceeded": false,
  • "hasTimeThresholdExceeded": false,
  • "createdAt": "2025-05-31T10:00:00.000Z",
  • "modifiedAt": "2025-05-31T10:00:00.000Z",
  • "hasThresholdExceeded": false,
  • "isMpAssociated": false,
  • "requestid": 0,
  • "isParApproved": false
}

DisclosureProfileChangeLogListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (DisclosureProfileChangeLogListData)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

DisclosureEntitiesListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (DisclosureEntity)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

DisclosureInformationResponse

trainingLastCompletedDate
string <date-time>

The timestamp when the training was last completed.

disclosureStatus
string

Workflow state of the disclosure profile.

disclosureProfileLastCompletedDate
string <date-time>

The timestamp when the profile was last completed.

{
  • "trainingLastCompletedDate": "2019-08-24T14:15:22Z",
  • "disclosureStatus": "string",
  • "disclosureProfileLastCompletedDate": "2019-08-24T14:15:22Z"
}

DisclosureProfile

hrn
string^hrn:hrs:disclosureprofile:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

id
string

Unique identifier of the disclosure profile.

profileId
integer

The ID of the disclosure entity profile associated with the disclosure entity.

name
string

Name of the disclosure profile (e.g., Disclosure Profile for John).

object

The details of a disclosed person.

object

The details of a discloser proxy.

requiresProfileUpdate
boolean

Indicates whether the discloser profile requires an update. The values are true or false.

dateCreated
string <date-time>

The timestamp when profile was created.

dateModified
string <date-time>

The timestamp when profile was last modified.

hasAcceptedTrainingMaterials
boolean

Indicates whether the discloser has accepted training materials in the disclosure profile. The values are true or false.

hasOutsideActivities
boolean

Indicates whether the discloser has any outside activities or financial interests to disclose. The values are true or false.

isActive
boolean

Indicates whether the disclosure profile is active. The values are true or false. By default, the profile is active. If set to False, then it indicates the profile is deactivated.

projectStateId
string

The state of the disclosure profile (Active | InActive | ActionRequired | NoActionRequired).

previousProjectStateId
string

The previous state of the project before the current one.

workflowState
string

The disclosure profile's current state.

firstName
string

The given first name of a discloser profile.

lastName
string

The surname or family name of the discloser profile.

object

Contact information of the person.

object

Details of the Organization.

Array of objects

List of categories for which training has been accepted.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

disclosureProfileHrn
string^hrn:hrs:disclosureprofile:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

hasVentureCaptalEnableAsEquityDisclosuer
boolean

Indicates whether to enable venture capital in equity type disclosure. The values are true or false.

isApplicableToAllPersonnel
boolean

Indicates whether discloser profile applies to all personnel. The values are true or false.

managementPlanCount
integer

The number of management plans associated with the profile.

stateLastUpdated
string <date-time>

The timestamp when last time the state was last updated.

daysInCurrentState
integer

The days since no state has changed

projectStateDisplayName
string

Label/name of the project state ID.

profileUpdatedDate
string <date-time>

The timestamp when the disclosure profile was most recently updated.

active
boolean

Indicates whether the project appears in picklists. The values are true or false.

Array of objects (SmartformStep)

Active Flex steps for disclosure profile configured in Step Flex Settings.

researchTrainingDate
string <date-time>

The date the research training was completed.

isLastTrainingCompleted
boolean

Indicates whether the most recent required training has been completed. The values are true or false.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects

Tags associated with the disclosure profile.

Array of objects (UpdateDisclosureEntity)
stateLastUppdated
string <date-time>

The last time the profile state was updated.

Array of objects

Version history of the disclosure profile.

isCustomPropertiesModified
boolean

Indicates if any custom fields have been modified. The values are true or false.

discloserDisplayName
string

Full name of the discloser.

emailDisplayName
string <email>

Displayed email address of the discloser.

isSfUpdated
boolean

Indicates if Salesforce (or similar system) has been updated. The values are true or false.

isCompleteProxyCompleted
boolean

Whether the discloser proxy section has been fully completed. The values are true or false.

hasOutstandingPortfolioTasks
boolean

Indicates whether there are any outstanding portfolio review tasks. The values are true or false.

foreignTalentDescription
string

Notes or description regarding foreign talent disclosure.

hasApplicantOrParticipant
boolean

Indicates whether the discloser is an applicant or participant in related programs. The values are true or false.

hasActiveStartupPackage
boolean

Indicates whether the discloser has an active startup funding package. The values are true or false.

hasStartupCompanyIntellectual
boolean

Indicates whether the discloser has intellectual property in a startup. The values are true or false.

hasThresholdExceeded
boolean

Indicates whether any disclosure exceeds the dollar/time threshold. The values are true or false.

IsResolvePortfolioVisible
boolean

Indicates whether the "Resolve Portfolio" button is visible. The values are true or false.

IsDiscloserPresentInOffices
boolean

Indicates whether the discloser is assigned to any COI office. The values are true or false.

IsDiscloserHasCoia
boolean

True if discloser has a COI admin assigned. The values are true or false.

isUserIsAssignReviewer
boolean

Indicates whether the current user is assigned as a reviewer. The values are true or false.

currentUserHasAccessToDp
boolean

Indicates whethe the current user has access to view the disclosure profile. The values are true or false.

Array of objects

List of reviewers assigned to handle portfolio review tasks.

organisationName
string

Name of the organization.

email
string <email>

Primary email address of the discloser.

object

Custom key-value pairs defined for the profile.

object

Draft data version of the disclosure profile.

employerName
string

Employer name associated with the discloser.

secondaryUnitName
string

Secondary unit name, if applicable.

additionalUnitName
string

Additional unit name, if applicable.

organizationName
string

Name of the organization linked to the discloser.

isMpAssociatedEntityUpdated
boolean

Indicates whether any entity associated with a management plan has been updated. The values are true or false.

object

Metadata about training expiration and forced profile updates.

object

Custom field values saved in draft.

Array of objects

Dynamic form data organized by steps.

Array of objects

Draft entity disclosures associated with the profile.

{
  • "hrn": "string",
  • "disclosureHrn": {
    },
  • "id": "DP00000025",
  • "profileId": 0,
  • "name": "Disclosure Profile for Huron Administrator",
  • "discloser": {
    },
  • "discloserProxy": {
    },
  • "requiresProfileUpdate": true,
  • "dateCreated": "2023-04-14T11:55:33.020703Z",
  • "dateModified": "2025-05-07T06:31:50.250883Z",
  • "hasAcceptedTrainingMaterials": true,
  • "hasOutsideActivities": true,
  • "isActive": true,
  • "projectStateId": "ActionRequired",
  • "previousProjectStateId": "NoActionRequired",
  • "workflowState": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "contactInformation": {
    },
  • "employer": {
    },
  • "hasAcceptedData": [
    ],
  • "createdBy": {
    },
  • "disclosureProfileHrn": "string",
  • "hasVentureCaptalEnableAsEquityDisclosuer": true,
  • "isApplicableToAllPersonnel": true,
  • "managementPlanCount": 0,
  • "stateLastUpdated": "2019-08-24T14:15:22Z",
  • "daysInCurrentState": 0,
  • "projectStateDisplayName": "string",
  • "profileUpdatedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "smartformSteps": [
    ],
  • "researchTrainingDate": "2025-03-22T11:36:16.893619Z",
  • "isLastTrainingCompleted": false,
  • "disclosureProxyHrn": {
    },
  • "tags": [
    ],
  • "disclosureEntities": [
    ],
  • "stateLastUppdated": "2025-04-07T06:02:46.15192Z",
  • "versions": [
    ],
  • "isCustomPropertiesModified": true,
  • "discloserDisplayName": "Huron Administrator",
  • "emailDisplayName": "admin@hcg.com",
  • "isSfUpdated": true,
  • "isCompleteProxyCompleted": false,
  • "hasOutstandingPortfolioTasks": true,
  • "foreignTalentDescription": "ggggdfgdfg gg gg aa aaa",
  • "hasApplicantOrParticipant": true,
  • "hasActiveStartupPackage": true,
  • "hasStartupCompanyIntellectual": true,
  • "hasThresholdExceeded": true,
  • "IsResolvePortfolioVisible": false,
  • "IsDiscloserPresentInOffices": false,
  • "IsDiscloserHasCoia": true,
  • "isUserIsAssignReviewer": true,
  • "currentUserHasAccessToDp": true,
  • "portfolioReviewTaskAssignedTo": [
    ],
  • "organisationName": "Huron Consulting Group",
  • "email": "admin@hcg.com",
  • "customProperties": { },
  • "dpDraftData": {
    },
  • "employerName": "",
  • "secondaryUnitName": "",
  • "additionalUnitName": "",
  • "organizationName": "",
  • "isMpAssociatedEntityUpdated": true,
  • "gracePeriodData": {
    },
  • "draftCustomData": {
    },
  • "stepFormData": [
    ],
  • "entityDraftData": [
    ]
}

DisclosureProfilesListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (DisclosureProfile)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

DisclosureTypesDetails

disclosureTypesName
string

Name of the disclosure type.

anyOfThisType
string

Indicates if there is a related type check.

Array of objects (TotalValues)

The details of public Equity and non-Public Equity.

{
  • "disclosureTypesName": "string",
  • "anyOfThisType": "string",
  • "totalValues": [
    ]
}

DisclosureProfileByPersonList

object

Details of a disclosed person.

submittedDate
string <date-time>

The timestamp when the profile was submitted.

isActive
boolean

Indicates whether the disclosure profile is active. The values are true or false. By default, the profile is active. If set to False, then it indicates the profile is deactivated.

disclosureProfileHrn
string^hrn:hrs:disclosureprofile:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

hasExceededThreshold
boolean

Indicates whether threshold is increased for a disclosure profile. The values are true or false.

requiresProfileUpdate
boolean

Indicates whether profile update is required for a disclosure profile after making any new change. The values are true or false.

{
  • "discloser": {
    },
  • "submittedDate": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "disclosureProfileHrn": "string",
  • "hasExceededThreshold": false,
  • "requiresProfileUpdate": true
}

DisclosureProfileByPersonsResponseList

Array of objects (DisclosureProfileByPersonList)

List of persons.

{
  • "data": [
    ]
}

DeactivateDisclosureProfile

required
Array of objects (PersonRef)
reasonForDeactivation
required
string

Details of the reason(s) for deactivating the active disclosure profile(s).

Array of objects (DocumentRef)

An array of supporting documents.

Array of objects (actionLogFormData)

Metadata about the form fields shown in the action log interface.

{
  • "disclosers": [
    ],
  • "reasonForDeactivation": "string",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ]
}

EventType

id
string

Identifier of the event types (e.g., IRBSubmission, GrantsJIT).

eventTypeName
string

The name which defines the event type.

eventTypeStatus
boolean

Indicates whether the event is currently used. The values are true or false.

eventTypeDisplayOrder
number

The order in which the event type is listed (e.g., 1, 2 ).

{
  • "id": "string",
  • "eventTypeName": "string",
  • "eventTypeStatus": true,
  • "eventTypeDisplayOrder": 0
}

EligibleProxy

object

Information about the organization.

{
  • "proxy": {
    }
}

ExpireTrainingBulkProcess

required
Array of objects (PersonRef)

Information about persons.

comments
string

User comments (if required).

Array of objects (DocumentRef)

Documents entered on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

categoriesId
required
Array of strings

Categories ID of the selected persons.

personnelType
required
string

Information about selection of selected personnel or all personnel.

{
  • "discloser": [
    ],
  • "comments": "string",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ],
  • "categoriesId": [
    ],
  • "personnelType": "string"
}

EligibleProxiesListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (EligibleProxiesListResponseObject)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

ForceProfileUpdateBulkProcess

required
Array of objects (PersonRef)

Information about persons.

comments
string

Comments entered on action performed.

Array of objects (DocumentRef)

Documents entered on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

categoriesId
required
Array of strings

Categories ID of the selected persons.

personnelType
required
string

Information about selection of selected personnel or all personnel.

{
  • "discloser": [
    ],
  • "comments": "string",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ],
  • "categoriesId": [
    ],
  • "personnelType": "string"
}

FinalReviewStage

id
string <uuid>

UUID representation of Final stage review.

stageName
string

Stage name of review stage.

reviewType
string

Type of review.

distributedReviewType
string

Type of distributed review type.

adminOffice
string

Name of the admin office.

centralReviewType
string

Type of central review. This is relevant when the review type is Centralized Review. The review group consists of administrative office| department | individual.

object

Information about the person who is assigned as a dedicated reviewer.

object

Details of the Organization.

{
  • "id": "cb36f6b1-c8c0-49d4-90cd-50187e32c073",
  • "stageName": "string",
  • "reviewType": "string",
  • "distributedReviewType": "string",
  • "adminOffice": "string",
  • "centralReviewType": "string",
  • "dedicatedReviewer": {
    },
  • "department": {
    }
}

HRN

<SchemaDefinition schemaRef="#/components/schemas/HRN" />

IntermediateReviewStages

adminOffice
string

Name of the admin office.

centralReviewType
string

Type of central review. This is relevant when the review type is Centralized Review. The review group consists of administrative office| department| individual.

object

Information about the person who is assigned as a dedicated reviewer.

object

Details of the Organization.

distributedReviewType
string

Type of a distributed review. This is relevant when the review type is Distributed Review. This review group consists of supervisor| employer |department |division |college.

Array of objects
reviewType
string

Type of the review (Centralized Review | Distributed Review ).

shouldUseDefaultReviewer
boolean

Indicates whether the review should use the default reviewer for the admin office. The values are true or false.

stageName
string

The name of the review stage.

stageOrder
integer

The order of the review stage. The maximum value is 100.

{
  • "adminOffice": "string",
  • "centralReviewType": "string",
  • "dedicatedReviewer": {
    },
  • "department": {
    },
  • "distributedReviewType": "string",
  • "excludedDisclosers": [
    ],
  • "reviewType": "string",
  • "shouldUseDefaultReviewer": true,
  • "stageName": "string",
  • "stageOrder": 0
}

InKindSupport

id
string

Identifier of the support types (e.g., Supplies, Equipment).

inKindSupportName
string

The name which defines the support type.

inKindSupportDescription
string

Description of the support type.

inKindSupportStatus
boolean

Indicates whether the support is currently used. The values are true or false.

inKindSupportDisplayOrder
number

The order in which the support type is listed (e.g., 1, 2 ).

{
  • "id": "string",
  • "inKindSupportName": "string",
  • "inKindSupportDescription": "string",
  • "inKindSupportStatus": true,
  • "inKindSupportDisplayOrder": 0
}

Id

string (Id)

ID of the resource.

"string"

InKindSupportSettings

Array of objects (InKindSupport)

Details of the in-kind support.

{
  • "inKindSupport": [
    ]
}

ImportResponse

Array
hrn
string (HRN)

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

correlationId
string

Unique key for every record. The same value is present in the import request.

httpStatus
integer

The three digit HTTP status code.

id
string

Name of the reference key in the actual object for import.

object (Errors)
[
  • {
    }
]

BulkImportCertification

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects
{
  • "idFieldName": "string",
  • "data": [
    ]
}

BulkImportTriggeringEvents

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects
{
  • "idFieldName": "string",
  • "data": [
    ]
}

TriggeringEventRequestBodyForImport

id
string

Identifier of Triggering Event. ID value must be unique.

sourceIdentifier
string

Source identifier of the Triggering Event. Source identifier has to be unique.

title
required
string

The title of the triggering event provided at creation.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

startDate
string <date-time>

The date the triggering event project is estimated to start.

endDate
string <date-time>

The date the triggering event project is estimated to end.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (ResearchPersonnelForImport)
object^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects[ items^hrn:hrs:orgs:[0-9]+$ ]
Array of objects[ items^hrn:hrs:orgs:[0-9]+$ ]
scope
string

The scope of the triggering event project.

drugsAndTechnology
string

The description of the drugs and technology involved in the triggering event project.

dateCreated
string <date-time>

The timestamp when the certification was created.

dateModified
string <date-time>

The timestamp when the certification was last modified.

Array of objects[ items^hrn:hrs:documents:[a-z0-9]+$ ]
customProperties
object

A JSON object that contains the Flex data conforming to the List Items custom object definitions.

Array of objects[ items^hrn:hrs:persons:[0-9]+$ ]

List of HRNs of Related Project Assigned Coordinator / Administrative Contacts from the source system.

relatedProjectHrn
string

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

{
  • "id": "string",
  • "sourceIdentifier": "string",
  • "title": "Provident Funds Triggering Event",
  • "primaryContact": {
    },
  • "eventType": {
    },
  • "startDate": "2025-05-01T10:00:00.000Z",
  • "endDate": "2025-05-31T10:00:00.000Z",
  • "assignCoordinator": {
    },
  • "principalInvestigator": {
    },
  • "researchPersonnel": [
    ],
  • "sponsor": {
    },
  • "associatedOrganizations": [
    ],
  • "associatedInternalOrganizations": [
    ],
  • "scope": "string",
  • "drugsAndTechnology": "Lorem ipsum dolor sit amet.",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "supportingDocuments": [
    ],
  • "customProperties": {
    },
  • "adminContacts": [
    ],
  • "relatedProjectHrn": "string"
}

ManagementPlanRequestBodyForImport

id
required
string

Id of management plan Id value has to unique.

sourceIdentifier
string

Source Identifier of the management plan Source Identifier has to be unique.

name
required
string

The name of the management plan provided at creation.

Array of objects[ items^hrn:hrs:certifications:[0-9]+$ ]
required
object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

required
object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

required
object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

dateCreated
string <date-time>

The timestamp when the Management plan was created.

dateModified
string <date-time>

The timestamp when the Management plan was last modified.

projectState
required
string

Project State of management plan.

object^hrn:hrs:documents:[a-z0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects[ items^hrn:hrs:persons:[0-9]+$ ]
stateLastUpdated
string <date-time>

The date the management plan project state was last updated.

object

route plan additional details.

object

review Comments documents.

customProperties
object

A JSON object that contains the Flex data conforming to the List Items custom object definitions.

object^hrn:hrs:documents:[a-z0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

lastAcceptedDate
string <date-time>

The date the management plan project was last accepted.

datePlanLastAccepted
string <date-time>

The date the management plan project was last accepted.

Array of objects (ConflictObjectDetails)

Array of conflicts which is updated by user.

{
  • "id": "string",
  • "sourceIdentifier": "string",
  • "name": "Management Plan for Project X",
  • "certifications": [
    ],
  • "discloser": {
    },
  • "planCreator": {
    },
  • "createdBy": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "projectState": "string",
  • "planDocument": {
    },
  • "planMonitors": [
    ],
  • "stateLastUpdated": "2019-08-24T14:15:22Z",
  • "routeplanAdditionalDetails": {
    },
  • "reviewCommentsDocuments": {
    },
  • "customProperties": {
    },
  • "finalPlanDocument": {
    },
  • "lastAcceptedDate": "2019-08-24T14:15:22Z",
  • "datePlanLastAccepted": "2019-08-24T14:15:22Z",
  • "updateConflictsData": [
    ]
}

ManagementPlanUpdateRequestBodyForImport

<SchemaDefinition schemaRef="#/components/schemas/ManagementPlanUpdateRequestBodyForImport" />

CertificationsHrn

hrn
required
string

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

name
string

The name associated to the record. The name can be empty or contain a value.

{
  • "hrn": "string",
  • "name": "string"
}

ReviewCommentsDocuments

decision
string

The decision made regarding the management plan project.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

dateCreated
string <date-time>

The timestamp when the Management plan was created.

discloserComment
string

Comments or additional information provided by the discloser regarding the management plan project.

Array of objects[ items^hrn:hrs:documents:[a-z0-9]+$ ]

Disclosure supporting document.

{
  • "decision": "string",
  • "createdBy": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "discloserComment": "string",
  • "discloserSupportingDocument": [
    ]
}

RoutePlanAdditionalDetails

comments
string

Comments or additional information related to the management plan project.

Array of objects[ items^hrn:hrs:documents:[a-z0-9]+$ ]
dateCreated
string <date-time>

The timestamp when the Management plan was created.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

{
  • "comments": "test additional information",
  • "supportingDocuments": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

IdFieldName

string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

"string"

IntermediateReviewStages

adminOffice
string

Name of the admin office.

centralReviewType
string

Type of central review. This is relevant when the review type is Centralized Review. The review group consists of administrative office| department| individual.

object

Information about the person who is assigned as a dedicated reviewer.

object

Details of the Organization.

distributedReviewType
string

Type of a distributed review. This is relevant when the review type is Distributed Review. This review group consists of supervisor| employer |department |division |college.

Array of objects
reviewType
string

Type of the review (Centralized Review | Distributed Review ).

shouldUseDefaultReviewer
boolean

Indicates whether the review should use the default reviewer for the admin office. The values are true or false.

stageName
string

The name of the review stage.

stageOrder
integer

The order of the review stage. The maximum value is 100.

{
  • "adminOffice": "string",
  • "centralReviewType": "string",
  • "dedicatedReviewer": {
    },
  • "department": {
    },
  • "distributedReviewType": "string",
  • "excludedDisclosers": [
    ],
  • "reviewType": "string",
  • "shouldUseDefaultReviewer": true,
  • "stageName": "string",
  • "stageOrder": 0
}

MigrateDisclosureProfile

discloserId
required
string

Discloser ID of a profile that needs to migrate.

name
required
string <= 255 characters

Name of the discloser profile.

required
object

To migrate only mention the HRN of person.

object

To migrate only mention the HRN of person.

hasAcceptedTrainingMaterials
boolean

Indicates whether the discloser has accepted training materials in the disclosure profile. The values are true or false.

hasOutsideActivities
boolean

Indicates whether the discloser has any outside activities or financial interests to disclose. The values are true or false. If Outside Activities is set to true then, disclosureEntities needs to be migrated.

isActive
boolean

Indicates whether the profile migrated is active. The values are true or false.

dateCreated
required
string <date-time>

The timestamp when the profile was created, in UTC format.

dateModified
string <date-time>

Date on which profile was modified.

submittedDate
string <date-time>

Date on which profile was submitted.

trainingExpirationDate
string <date-time>

Date on which training has been expired.

projectStateId
required
string

The state of the disclosure profile (Active | InActive | ActionRequired | NoActionRequired).

previousProjectStateId
string

Previous project state ID.

workflowState
required
string

The disclosure profile's current state.

createdBy
required
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

modifiedBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

Array of objects (UpdateDisclosureEntity)
{
  • "discloserId": "string",
  • "name": "string",
  • "discloser": {
    },
  • "discloserProxy": {
    },
  • "hasAcceptedTrainingMaterials": true,
  • "hasOutsideActivities": true,
  • "isActive": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "submittedDate": "2019-08-24T14:15:22Z",
  • "trainingExpirationDate": "2019-08-24T14:15:22Z",
  • "projectStateId": "string",
  • "previousProjectStateId": "string",
  • "workflowState": "string",
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "disclosureEntities": [
    ]
}

ManagementPlan

name
required
string

Name of the management plan supplied at creation.

required
object (DocumentRef)
{
  • "name": "string",
  • "planDocument": {
    }
}

ManageClarification

object

Information about the clarification data.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "clarificationData": {
    },
  • "actionLogFormData": [
    ]
}

MigrationPlanDocument

object (DocumentRef)
object (DocumentRef)
lastAcceptedDate
string

Date and time about the management plan acceptance by the disclosure.

{
  • "draftManagementPlan": {
    },
  • "finalManagementPlan": {
    },
  • "lastAcceptedDate": "string"
}

ManageCertificationsExecutionStatus

status
string
Enum: "RUNNING" "SUCCEEDED" "FAILED" "TIMED_OUT" "ABORTED" "UNDEFINED"

The status of the certification execution (e.g., certification creation is in progress/completed).

{
  • "status": "RUNNING"
}

ManageWriteInEntities

disclosureEntityHrns
Array of strings

HRNs of the disclosure entity.

required
object^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

detailsOfChangingEntity
required
string

Details of the changing entity.

Array of objects (DocumentRef)

Documents entered on action performed.

isEmailNotificationRequired
required
boolean

Indicates whether to trigger a notification to discloser. The values are true or false.

notifyTo
Array of strings

Notification sent to the selected user (Assigned reviewer | Disclosure | Proxy).

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "disclosureEntityHrns": [
    ],
  • "entityHrn": {
    },
  • "detailsOfChangingEntity": "string",
  • "supportingDocuments": [
    ],
  • "isEmailNotificationRequired": true,
  • "notifyTo": [
    ],
  • "actionLogFormData": [
    ]
}

ManageProxyAssignments

object (ProxyAssignment)
Array of objects (actionLogFormData)

Metadata about the form fields shown in the action log interface.

{
  • "manageProxyAssignments": {
    },
  • "actionLogFormData": [
    ]
}

MigrateOrImportDocumentHrn

string (MigrateOrImportDocumentHrn) ^hrn:hrs:documents:[a-z0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

"string"

MigrateOrImportResearchRolesHrn

string (MigrateOrImportResearchRolesHrn)

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

"string"

MigrateOrImportEventHrn

string (MigrateOrImportEventHrn)

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

"string"

MigrateOrImportOrganizationHrn

string (MigrateOrImportOrganizationHrn) ^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

"string"

MigrateOrImportPersonHrn

hrn
required
string

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

name
string

The name associated to the record. The name can be empty or contain a value.

{
  • "hrn": "string",
  • "name": "string"
}

ManageEligibleProxies

required
Array of objects (EligibleProxy)
Array of objects (actionLogFormData)

Metadata about the form fields shown in the action log interface.

{
  • "eligibleProxies": [
    ],
  • "actionLogFormData": [
    ]
}

MigrateManagementPlan

id
string

ID of the management plan. This ID is from the legacy and is unique within the tenant.

certificationSourceIds
Array of strings

Certification Source ID from legacy.

name
string

Name of the management plan supplied at creation.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

planCreator
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

createdBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

projectState
string

The current state of the management plan in a project (e.g., Satisfied).

workflowState
string

The current state of the management plan in the workflow (e.g., Active).

planStatus
string

The current status of the management plan (e.g., Drafting).

stateLastUpdated
string <date-time>

The date and time the plan is last updated for state transition.

dateCreated
string <date-time>

The timestamp when the management plan was created.

dateModified
string <date-time>

The date and time the management plan was last changed, or an activity was executed on the management plan.

Array of objects (PersonRef)

The details of the plan monitors associated with the management plan.

object

Documents and details for the management plan.

{
  • "id": "string",
  • "certificationSourceIds": [
    ],
  • "name": "string",
  • "discloser": {
    },
  • "planCreator": "string",
  • "createdBy": "string",
  • "projectState": "string",
  • "workflowState": "string",
  • "planStatus": "string",
  • "stateLastUpdated": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "planMonitors": [
    ],
  • "planDocument": {
    }
}

ManageCategoryPersonnelBulkProcess

categoryId
string

Unique ID for category.

Array of objects (Personal)

Information about selected persons.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

Array of objects (Personal)

Information about removed persons.

{
  • "categoryId": "string",
  • "personnel": [
    ],
  • "actionLogFormData": [
    ],
  • "removedPersonnel": [
    ]
}

OrganizationExtended

object^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (PersonRef)
{
  • "organizationHrn": {
    },
  • "defaultReviewerHrn": {
    },
  • "reviewers": [
    ]
}

OrganizationsResource

object^hrn:hrs:orgs:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Name
string

Name of the entity.

Id
string

ID of the entity.

IsPubliclyTraded
boolean

Indicates whether the disclosure entity is publicly traded. The values are true or false.

This field is either updated from the organization profile of the organization selected as the entity, or from the write-in-field.

{
  • "Hrn": {
    },
  • "Name": "string",
  • "Id": "string",
  • "IsPubliclyTraded": true
}

OpenTriggeringEvent

reason
required
string

The reason for opening the triggering event.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "reason": "Reason to open triggering event",
  • "actionLogFormData": [
    ]
}

Plan

object

Details of the plan creator.

planName
string

Name of the plan.

associatePlanHrn
string^hrn:hrs:managementplan:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

object

Document entered while creating management plan.

{
  • "planCreator": {
    },
  • "planName": "string",
  • "associatePlanHrn": "string",
  • "planDocument": {
    }
}

PersonsRequiringProfileList

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

firstName
string

The given name of the person.

lastName
string

The surname or family name of the person.

name
string

The full name of the person, including the first name, last name, and middle name (if applicable).

employerName
string

Name of the employer to which personnel is associated

object

Contact information of the person.

object

Details of the Organization.

{
  • "hrn": {
    },
  • "firstName": "John",
  • "lastName": "Doe",
  • "name": "string",
  • "employerName": "US Department of Agriculture",
  • "contactInformation": {
    },
  • "employer": {
    }
}

ProfileRequiringPersons

data
object
{
  • "data": { }
}

PersonsRequiringProfileResponseList

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (PersonsRequiringProfileList)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

ProxyAssignmentListResponse

ProxyAssignment

ListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects

List of central action items.

{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

ProxyAssignment

required
object

Information about the proxy.

required
Array of objects (PersonRef)
isDiscloserActionAllowed
boolean

Indicates whether the proxy can take action on the discloser profile.

The values are true or false. Set to FALSE if the proxy cannot take action on the discloser profile.

isParActionAllowed
boolean

Indicates whether the proxy can take action on the pre-approval request.

The values are true or false. Set to FALSE if the proxy cannot take action on the pre-approval request.

Array of objects (actionLogFormData)

Metadata about the form fields shown in the action log interface.

{
  • "proxy": {
    },
  • "discloser": [
    ],
  • "isDiscloserActionAllowed": true,
  • "isParActionAllowed": true,
  • "actionLogFormData": [
    ]
}

PersonalCount

Array
count
integer

Count of all the personnel (e.g., 1844).

[
  • {
    }
]

ProxySettings

enableProxyFunctionality
string

Setting to enable a proxy's functionality of managing disclosures for specific disclosers. The values are Yes or No. If set to No, the other Proxy Settings options will not be available.

allowProxyDiscloserProfile
string

Setting to choose a different proxy or set of proxies for disclosure profiles. The values are Yes or No.

allowProxyCompleteDiscloserProfile
string

Setting to allow proxies to update the disclosure profile on behalf of the discloser. The values are Yes or No.

If set to Yes, proxies can submit disclosure profile updates on behalf of disclosers. If set to No, proxies can only update, but cannot submit the updated profile.

allowProxySubmitPreApprovalRequest
string

Setting to allow proxies to submit a Pre-Approval Request on behalf of the discloser. The values are Yes or No. If set to No, proxies can create a Pre-Approval Request for disclosers, but cannot submit it on their behalf.

allowProxyClarificationsRequest
string

Setting to allow proxies to execute the Respond to Clarifications Request action on behalf of the discloser. The values are Yes or No. If set to No, proxies cannot execute the Respond to Clarifications Request action on behalf of disclosers.

allowProxyReview
string

Setting to allow proxies to execute the Review and Accept Management Plan action on behalf of the discloser. The values are Yes or No. If set to No, proxies cannot execute the Review and Accept Management Plan action on behalf of disclosers

allowDiscloserManageProxy
string

Setting to allow disclosures to manage their proxy. The values are Yes or No. If set to Yes, the discloser can add, replace, or remove a proxy.

{
  • "enableProxyFunctionality": "string",
  • "allowProxyDiscloserProfile": "string",
  • "allowProxyCompleteDiscloserProfile": "string",
  • "allowProxySubmitPreApprovalRequest": "string",
  • "allowProxyClarificationsRequest": "string",
  • "allowProxyReview": "string",
  • "allowDiscloserManageProxy": "string"
}

Personnel

name
string

First and last name of the person.

hrn
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

object

Details of the Organization.

object

Contact information of the person.

activeItems
integer

Count of active or in-progress items (Certifications| ManagementPlan| TriggeringEvent) of the personnel (e.g.,10).

{
  • "name": "string",
  • "hrn": "string",
  • "employer": {
    },
  • "contactInformation": {
    },
  • "activeItems": 0
}

Personal

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

isProfileRequired
boolean

Indicates whether the Personnel's profile is available in COI system. The values are true or false. If the value is False, then the profile is created.

{
  • "personHrn": {
    },
  • "isProfileRequired": true
}

Personnels

<SchemaDefinition schemaRef="#/components/schemas/Personnels" />

PersonnelsListResponse

<SchemaDefinition schemaRef="#/components/schemas/PersonnelsListResponse" />

PersonExtended

personhrn
string

HRN of the person (e.g., hrn:hrs:persons:4296).

paymentId
string

A unique identifier for a payment transaction. This field is used for tracking or referencing a specific payment within the system (e.g., $345).

{
  • "personhrn": "string",
  • "paymentId": "string"
}

RequestClarification

comments
required
string

Comments entered on action performed.

Array of objects (DocumentRef)

Documents entered on action performed.

clarificationResponseDueDate
string <date-time>

Due date for the clarification response.

{
  • "comments": "string",
  • "supportingDocuments": [
    ],
  • "clarificationResponseDueDate": "2025-05-06T11:15:52.760Z"
}

RequiringPerson

object

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

name
string

Name of the person.

{
  • "personHrn": {
    },
  • "name": "lorem ipsum"
}

RequirePerson

hrn
required
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

id
string

A unique ID for the Person. It should consist only of letters, numbers, and the "-" or "_" characters.

active
boolean
Default: true

Indicates whether the Person is active. The values are true or false. Set to FALSE for contact records that need to be referenced, but which are no longer active.

firstName
string [ 1 .. 255 ] characters

The given name of the person.

lastName
string [ 1 .. 255 ] characters

The surname or family name of the person.

Array of objects

List of rights of a person.

userId
string

User ID of a person.

object

Contact information of the person.

object

Details of the Organization.

object

Details of the Organization.

object

Details of the Organization.

object

Details of the Organization.

{
  • "hrn": "string",
  • "id": "string",
  • "active": true,
  • "firstName": "string",
  • "lastName": "string",
  • "rights": [
    ],
  • "userId": "admin_hrsv12@hcg.com",
  • "contactInformation": {
    },
  • "employer": {
    },
  • "organization": {
    },
  • "secondaryUnit": {
    },
  • "additionalUnit": {
    }
}

ReviewForBulkImport

is_final
required
boolean

Indicates whether the review is final. The values are true or false.

is_committee_review
required
boolean

Indicates whether the review is a committee review. The values are true or false.

required
object

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (ConflictObject)

Details of the requested document.

assign_for_committee
boolean

Indicates whether the review is assigned for committee. The values are true or false.

object

The review stages of the certification (final_review_stage | intermediate_review_stage ).

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

review_completed_date
string <date-time>

The timestamp when the review was completed.

date_created
string <date-time>

The timestamp when the review was created.

date_modified
string <date-time>

The timestamp when the review was last modified.

object^hrn:hrs:managementplan:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object^hrn:hrs:meetings:[a-z0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

additional_action_needed
boolean

Indicates whether additional action is needed. The values are true or false.

submit_my_review_notes
string

Notes submitted by the reviewer.

submit_review_notes
string

Notes submitted by the reviewer.

submit_committe_review_notes
string

Notes submitted by the committee reviewer.

Array of objects[ items^hrn:hrs:documents:[a-z0-9]+$ ]
Array of objects[ items^hrn:hrs:documents:[a-z0-9]+$ ]
Array of objects[ items^hrn:hrs:documents:[a-z0-9]+$ ]
{
  • "is_final": true,
  • "is_committee_review": true,
  • "determination_hrn": {
    },
  • "follow_up_action_hrn": {
    },
  • "conflicts": [
    ],
  • "assign_for_committee": true,
  • "reviewStages": {
    },
  • "reviewer_hrn": {
    },
  • "review_completed_date": "2025-05-01T10:00:00.000Z",
  • "date_created": "2025-05-01T10:00:00.000Z",
  • "date_modified": "2025-05-01T10:00:00.000Z",
  • "management_plan_hrn": {
    },
  • "meeting_hrn": {
    },
  • "additional_action_needed": true,
  • "submit_my_review_notes": "string",
  • "submit_review_notes": "string",
  • "submit_committe_review_notes": "string",
  • "submit_my_review_document": [
    ],
  • "submit_review_document": [
    ],
  • "submit_committee_review_document": [
    ]
}

ReviewStages

Array of objects (ReviewStageResource)

Details of the intermediate review stages.

Array of objects (ReviewStageResource)

Details of the final review stage.

{
  • "intermediateReviewStages": [
    ],
  • "finalReviewStage": [
    ]
}

ReviewWorkflowTemplate

templateName
string

Name of the template.

templateId
integer

Unique ID of each template (e.g., 160).

priority
integer

Priority is an integer field which we used to request project workflow reviewer determination.

object

Information about the final review stage.

Array of objects (IntermediateReviewStages)

Information about intermediate review stage.

dateCreated
string <date-time>

Timestamp indicating when the record was created.

dateModified
string <date-time>

Timestamp indicating the last time the record was modified.

createdBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

isActive
boolean

Indicates whether the record is currently active. The values are true or false.

id
string

Unique identifier for the record.

{
  • "templateName": "string",
  • "templateId": 0,
  • "priority": 0,
  • "finalReviewStage": {
    },
  • "intermediateReviewStages": [
    ],
  • "dateCreated": "2024-04-10T18:26:41.371Z",
  • "dateModified": "2024-07-27T04:06:34.020Z",
  • "createdBy": "string",
  • "isActive": true,
  • "id": "e2f0ea5b-d8ac-4d3c-adc1-cf2d82bd83d1"
}

RemoveTrainingTasks

object (RemoveTrainingTasks)
{ }

ReviewWorkflowTemplateListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (ReviewWorkflowTemplate)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

review

sourceIdentifier
required
string

ID of the review in a source system.

NOTE: For migration, use review id from legacy system.

required
object^hrn:hrs:lists:coi-review-determination-list/...

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object^hrn:hrs:lists:coi-review-follow-up-action-li...

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

object

Information about the conflicts.

assignForCommittee
required
boolean

Indicates whether the certification should be assigned to committee review. The values are true or false.

isFinal
boolean

Indicates whether the review record is the final review stage in the process. The values are true or false.

isCommitteeReview
boolean

Indicates whether the final reviewer believes the certification should be assigned to committee review. The values are true or false.

required
object

Review stage data associated with the review record.

reviewer
required
string

Huron Resource Name, system generated unique value

reviewCompletedDate
required
string <date-time>

The timestamp when the review was completed.

dateCreated
required
string <date-time>

The timestamp when the review was created.

dateModified
required
string <date-time>

The timestamp when the review was last modified.

notes
required
string

Additional information and notes entered by a reviewer when submitting their review.

Array of objects (DocumentRef)

Details of the supporting document.

dateStageBegin
string <date-time>

The timestamp when the certification entered the current review stage.

{
  • "sourceIdentifier": "string",
  • "determination": {
    },
  • "followUpAction": {
    },
  • "conflicts": {
    },
  • "assignForCommittee": true,
  • "isFinal": true,
  • "isCommitteeReview": true,
  • "reviewStages": {
    },
  • "reviewer": "string",
  • "reviewCompletedDate": "2019-08-24T14:15:22Z",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "supportingDocuments": [
    ],
  • "dateStageBegin": "2019-08-24T14:15:22Z"
}

reactivatedisclosureprofiles

required
Array of objects (PersonRef)
reasonForReactivation
required
string

Details of the reason(s) for reactivating the deactivated disclosure profile(s).

isEmailNotificationRequired
boolean

Indicates whether to notify the reactivated user(s) through an email. The values are true or false.

Array of objects (DocumentRef)

Documents entered on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "disclosers": [
    ],
  • "reasonForReactivation": "string",
  • "isEmailNotificationRequired": true,
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ]
}

ReviewStageResource

stageName
string

The name of the review stage.

stageOrder
integer

The order of the review stage (e.g., If the review is in the second stage, the value is "2").

reviewType
string

Information about the review type (e.g., centralized/distributed).

centralReviewType
string

The type of central review for the current review state of the certification. This is relevant only for "Centralized Review" review type.

adminOffice
string

The name of the admin office assigned to the review.

object

Details of the Organization.

object

Details of the dedicated reviewer.

distributedReviewType
string

The type of distributed review for the current review stage of the certification.

Array of objects
shouldUseDefaultReviewer
boolean

Indicates whether the current review state should use the default reviewer for the admin office. The values are true or false.

dateStageBegin
string <date-time>

The timestamp when the certification entered the current review stage.

{
  • "stageName": "string",
  • "stageOrder": 0,
  • "reviewType": "string",
  • "centralReviewType": "string",
  • "adminOffice": "string",
  • "department": {
    },
  • "dedicatedReviewer": {
    },
  • "distributedReviewType": "string",
  • "excludedDisclosers": [
    ],
  • "shouldUseDefaultReviewer": true,
  • "dateStageBegin": "2019-08-24T14:15:22Z"
}

ReturnForReview

comments
string

Comment(s) entered on action performed.

object

Stage details based on selection.

Array of objects (DocumentRef)

Documents entered on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "comments": "string",
  • "currentReviewStage": {
    },
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ]
}

RelatedProjectsRetroReviewResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (RetrospectiveReviewRelatedProjectDetails)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

RetrospectiveReviewListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects (RetrospectiveReviewGetResponse)
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

ReassignManagementPlan

object^hrn:hrs:lists:coi-review-follow-up-action-li...

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects

Metadata entries for form UI rendering related to reassignment.

object

Detailed data for the reassigned management plan.

{
  • "followUpAction": {
    },
  • "actionLogFormData": [
    ],
  • "managementPlan": {
    }
}

RemoveFromAgenda

Array of objects

Metadata about how fields related to removal from agenda are displayed in forms.

Array of objects (DocumentRef)

Documents provided in support of the removal request.

comments
string

Additional comments explaining the reason for removal from agenda.

{
  • "actionLogFormData": [
    ],
  • "supportingDocuments": [
    ],
  • "comments": "removing from agenda"
}

RemoveTag

object^hrn:hrs:lists:tags/[a-z0-9-]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

name
string

Name of the tag on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "hrn": {
    },
  • "name": "string",
  • "actionLogFormData": [
    ]
}

RetrospectiveReview

id
string <= 55 characters

An identifier generated during creation of the retrospective review. Each ID is unique within the tenant.

required
object

Details of the discloser.

NOTE: For v10 to v12 migration, the expected value is only the HRN of discloser.

name
required
string

Name of the retrospective review.

findingsOfReview
string

Details of a particular retrospective review.

reasonForReview
string

Details of the reason why retrospective review was performed.

methodology
string

Details for explaining the retrospective review (e.g., document reviewed).

discoveryDate
required
string <date-time>

Date that the institution reached a conclusion that non-compliance had occurred.

NOTE: Only past dates are valid.

Array of objects (DocumentRef)

Details of the supporting documents.

NOTE: For V10 to V12 migration, the expected value is only hrn of documents.

Array of objects (TriggeringEventDetail)

Details of the related projects.

NOTE: For V10 to V12 migration, the expected value is only the hrn of projects.

Array of objects (Entities)

Details of the conflicting entities.

NOTE: For V10 to V12 migration, the expected value is only the HRN of Entities.

projectStateId
string

State identifier of the retrospective review project (e.g., InReview).

previousProjectStateId
string

State identifier of the previous retrospective review project.

NOTE: For V10 to V12 migration, previous project state is not necessary.

Array of objects (SubmitRetrospectiveReview)

Details of Submit retrospective review Action.

Array of objects (SubmitMitigationPlan)

Details of Submit Mitigation Plan Action.

Array of objects (PersonRef)

Details of the assigned reviewer.

NOTE: For V10 to V12 migration, the expected value is only the hrn of assigned reviewer.

isMigrated
boolean

Indicates whether retrospective review record is migrated. The values are true or false. Set the value to TRUE for migration. This is a required field for V10 to V12 migration and is only used for migration.

dateCreated
string <date-time>

Date retrospective review record was created.

This field is used only for V10 to V12 migration.

dateModified
string <date-time>

The timestamp indicating the last time a retrospective review record was modified.

This field is used only for V10 to V12 migration.

createdBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (SmartformStep)

Active Flex steps for retrospective review configured in Step Flex Settings.

{
  • "id": "string",
  • "discloser": {
    },
  • "name": "string",
  • "findingsOfReview": "string",
  • "reasonForReview": "string",
  • "methodology": "string",
  • "discoveryDate": "2021-03-30T10:05:30.000Z",
  • "supportingDocuments": [
    ],
  • "relatedProjects": [
    ],
  • "conflictingEntities": [
    ],
  • "projectStateId": "string",
  • "previousProjectStateId": "string",
  • "submitRetrospectiveReview": [
    ],
  • "submitMitigationPlan": [
    ],
  • "assignReviewer": [
    ],
  • "isMigrated": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "smartformSteps": [
    ]
}

RelationToDisclosersSettings

RelationToDisclosers

Settings

Array of objects (RelationToDisclosers)

Details of relation to the discloser.

{
  • "relationtoDiscloser": [
    ]
}

RelationToDisclosers

id
string

Identifier of the relation types (e.g., Self, Spouse).

relationToDiscloserName
string

The name which defines the relation (e.g., Self, Spouse).

relationToDiscloserIsActive
boolean

Indicates whether the relation is currently used. The values are True or False.

relationToDiscloserDisplayOrder
number

The order in which the relations are listed (e.g., 1, 2 ).

{
  • "id": "string",
  • "relationToDiscloserName": "string",
  • "relationToDiscloserIsActive": true,
  • "relationToDiscloserDisplayOrder": 0
}

RequiringPersons

Array of objects (RequiringPerson)
{
  • "personnel": [
    ]
}

ResearchPersonnel

object (MigrateOrImportPersonHrn) ^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects

The roles assigned to the person serving as a research personnel member on the triggering event.

additionalRoles
string

The additional roles entered for the person serving as a research personnel member on the triggering event.

customProperties
object

A JSON object that contains the Flex data conforming to the List Items custom object definitions.

id
string

Unique ID for Research Personnel associated with the Triggering Event (For UI Operation).

{
  • "person": {
    },
  • "roles": [
    ],
  • "additionalRoles": "string",
  • "customProperties": {
    },
  • "id": "b06eadcb-4c21-47a4-bb5c-c45408265c21"
}

ReturnPlanToDrafting

resetRemoveFinalPlan
required
boolean

Indicates whether to reset or remove the final plan. The values are yes or no. Set to NO if the plan needs no reset or removal.

comments
string

Comments on the action performed.

Array of objects (DocumentRef)

Supporting document for Return Plan to Drafting action.

Array of objects (ActionLogFormData)

Details of the form data for logging action.

{
  • "resetRemoveFinalPlan": true,
  • "comments": "string",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ]
}

RoutePlan

comments
string

Comments on the action performed.

nextStep
string
Enum: "CollaborateOnPlan" "SendPlanForAcceptance" "AdministrativelyAcceptPlan"

Next step of the route plan. The following are the three options for next step:

  • Collaborate On Plan
  • Send plan for acceptance, and
  • Administratively accept plan
object

Supporting Document of the action.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "comments": "string",
  • "nextStep": "CollaborateOnPlan",
  • "supportingDocuments": {
    },
  • "actionLogFormData": [
    ]
}

ResetReviewStages

required
object

Current Review Stage related details.

required
object

Data related to intermediate and final review stages.

templatename
string

Name of the template.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "currentReviewStage": {
    },
  • "reviewStages": {
    },
  • "templatename": "string",
  • "actionLogFormData": [
    ]
}

SubmitMyReview

additionalActionNeeded
required
boolean

Indicates whether additional action is needed for assigning the certification to management plan while doing review. The values are true or false.

notes
string

Comments on the action performed.

Array of objects (DocumentRef)

Documents entered on the action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "additionalActionNeeded": true,
  • "notes": "string",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ]
}

SubmitReview

required
object^hrn:hrs:lists:coi-review-determination-list/...

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

assignForCommittee
boolean

Indicates whether the certification should be assigned to committee review. The values are true or false.

object^hrn:hrs:lists:coi-review-follow-up-action-li...

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

notes
string

Additional information and notes entered by a reviewer when submitting their review.

object

Information about management plan.

Array of objects (Conflict)

Description and entities HRN while adding conflicts.

Array of objects (DocumentRef)

Documents entered on action performed.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "determination": {
    },
  • "assignForCommittee": true,
  • "followUpAction": {
    },
  • "notes": "string",
  • "managementPlan": {
    },
  • "conflicts": [
    ],
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ]
}

SmartformStep

stepId
integer

Unique ID of the SmartForm step.

id
integer

Unique ID of the SmartForm step for database reference.

title
string

Title of the SmartForm step.

displayOrder
number

Display order of the SmartForm step (e.g., 1,2).

projectType
string

Type of COI project to which the step is assigned (e.g., Disclosure Profile, Management Plan, Retrospective Review, Triggering Event, Pre Approval Request).

Array of objects (COISettingsCOICategories) [ items ]

List of active Categories to which step is assigned. This setting option will display only if ShowToAllDisclosers is set to False.

active
boolean

Indicates whether the step is active. The values are true or false.

showToAllDisclosers
boolean

Indicates whether the step is shown to all disclosers. The values are true or false.

NOTE: This field is applicable only to disclosure profile and Pre-Approval Request project types.

dateCreated
string <date-time>

The timestamp when the category was created.

dateModified
string <date-time>

The timestamp when the category was last updated.

categoriesNames
string

Name of the categories to which step is assigned.

{
  • "stepId": 0,
  • "id": 0,
  • "title": "string",
  • "displayOrder": 0,
  • "projectType": "string",
  • "categories": [
    ],
  • "active": true,
  • "showToAllDisclosers": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "categoriesNames": "string"
}

SubmitRetrospectiveReview

hasBias
required
boolean

Indicates whether extra verification is needed for the retrospective review record. The values are Yes or No. Set to YES if SubmitMitigationPlan action needs to be performed.

comments
string

Extra information for SubmitRetrospectiveReview action .

Array of objects (DocumentRef)

Information about the supporting documents.

NOTE: For v10 to v12 migration, the expected value is only the HRN of documents.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

customProperties
object

Custom properties or additional fields.

{
  • "hasBias": true,
  • "comments": "string",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ],
  • "customProperties": {
    }
}

SubmitMitigationPlan

planName
required
string

Name of the mitigation plan.

description
required
string

Providing the institution's plan of action to eliminate or mitigate the effect of the bias.

dateSubmitted
required
string <date-time>

Date and time the mitigation plan was submitted to the funding agency.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

customProperties
object

Custom properties or additional fields.

{
  • "planName": "string",
  • "description": "string",
  • "dateSubmitted": "2019-08-24T14:15:22Z",
  • "actionLogFormData": [
    ],
  • "customProperties": {
    }
}

SCRReview

scrTabled
boolean

Indicates whether the review was tabled during committee review. The values are true or false.

object

The final determination made by the committee.

scrDeterminations
string or null

Additional determination notes, if any.

scrDeterminationDate
string <date-time>

The date when the determinations were made.

scrVotes
object

Voting breakdown of the committee (empty if not recorded).

rationaleForDeterminationText
string

Explanation for the determination decision.

additionalInfoNotesText
string

Any additional notes or comments.

Array of objects (DocumentRef)

Documents entered on action performed.

submitReview
boolean

Indicates whether the review was submitted. The values are true or false.

scrEntitiesNotified
string or null

Entities notified about the decision, if any.

scrEntitiesNotifiedOther
string or null

Other notified entities not covered by default fields.

object

Type of action associated with the review outcome.

scrActionPlanDescription
string or null

Description of the action plan if applicable.

scrResponsiblePartiesSelection
string or null

Selected parties responsible for the management plan.

scrActionDueDate
string or null <date-time>

Due date for the action plan.

scrEffectiveDate
string or null <date-time>

Effective date of the committee review.

scrTriennialApprovalDate
string or null <date-time>
scrApprovalDate
string or null <date-time>

Date when the committee review was approved.

scrContReviewDate
string or null <date-time>
Array of objects

Descriptions of reported conflicts of interest.

scrManagementPlan
string^hrn:hrs:managementplan:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

object

Details of the plan creator.

scrManagementPlanTitle
string or null

Title of the management plan.

object (DocumentRef)
scrIsDeficiency
boolean

Indicates if the review identified any deficiencies.

scrDeficiencyTypes
Array of strings

List of deficiency types, if any.

scrDeficiencySeverities
string or null
scrDeficiencyCategory
string or null
scrIRBRiskLevel
string or null
scrIRBPediatricRiskLevels
string or null
scrControvertedIssues
string or null

Issues that are controverted.

scrDeterminationsFindings
string or null

Findings related to the determinations.

Array of objects

Metadata entries describing how fields appear in the UI forms.

{
  • "scrTabled": false,
  • "scrDetermination": {
    },
  • "scrDeterminations": null,
  • "scrDeterminationDate": "2025-05-06T11:15:52.760Z",
  • "scrVotes": { },
  • "rationaleForDeterminationText": "defghi",
  • "additionalInfoNotesText": "fgdf gdfgdfg",
  • "supportingDocuments": [
    ],
  • "submitReview": false,
  • "scrEntitiesNotified": null,
  • "scrEntitiesNotifiedOther": null,
  • "scrActionType": {
    },
  • "scrActionPlanDescription": null,
  • "scrResponsiblePartiesSelection": null,
  • "scrActionDueDate": null,
  • "scrEffectiveDate": null,
  • "scrTriennialApprovalDate": null,
  • "scrApprovalDate": null,
  • "scrContReviewDate": null,
  • "scrDescribeConflict": [
    ],
  • "scrManagementPlan": "string",
  • "scrManagementPlanCreator": {
    },
  • "scrManagementPlanTitle": null,
  • "scrManagementPlanDocument": {
    },
  • "scrIsDeficiency": false,
  • "scrDeficiencyTypes": [ ],
  • "scrDeficiencySeverities": null,
  • "scrDeficiencyCategory": null,
  • "scrIRBRiskLevel": null,
  • "scrIRBPediatricRiskLevels": null,
  • "scrControvertedIssues": null,
  • "scrDeterminationsFindings": null,
  • "actionLogFormData": [
    ]
}

SnapshotResource

requestId
string

Unique ID to identify snapshot.

versionNumber
number

Version number of the generated snapshot (e.g., 1, 2, 3).

version
string

Name of the snapshot with version number (e.g., "Snapshot 1.0").

url
string

URL of the generated snapshot.

fileName
string

Name of the generated snapshot (e.g., "Snapshot.pdf").

dateCreate
string <date-time>

The timestamp when the snapshot is generated.

snapshotEvent
string

Event at which snapshot is generated (e.g., Transition to Approved1.0").

{}

SubmitRequest

comments
required
string

Extra information passed at the time of submitting request.

Array of objects (DocumentRef)

An array of supporting documents.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "comments": "string",
  • "supportingDocuments": [
    ],
  • "actionLogFormData": [
    ]
}

SmartformStepListResponse

object (Pagination)

Describes pagination support.

object
Array of objects (SmartformStep)
object
{
  • "pagination": {
    },
  • "filters": {
    },
  • "data": [
    ],
  • "links": {
    }
}

TotalValues

fieldName
string

Name of the field (e.g., publicEquity, nonPublicEquity).

{
  • "fieldName": "string"
}

UpdateDisclosureProfile

hasOutsideActivities
required
boolean

Indicates whether the discloser has any outside activities or financial interests to disclose. The values are true or false.

Array of objects (UpdateDisclosureEntity)
{
  • "hasOutsideActivities": true,
  • "disclosureEntities": [
    ]
}

UpdateConflicts

Array of objects (ConflictObject)

Array of conflicts which is updated by user.

Array of objects (ActionLogFormData)

Details of the form data for logging action.

{
  • "updateConflictsData": [
    ],
  • "actionLogFormData": [
    ]
}

UpdateDisclosureEntity

entityId
required
string

ID of the entity. This contains UUID/GUID to help represent a record uniquely.

entitySource
required
string

Represents where an entity source is created from i.e., a Disclosure Profile or Pre-approval request (e.g., DisclosureProfile).

entityHrn
string^hrn:hrs:discloserentity:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

object

Details about write in entity. Either entityHrn or writeInEntity is required.

disclosureTypeId
required
string

ID of the disclosure type (e.g., Equity, Travel).

object
totalValue
integer

The total value of the estimated compensation.

totalDuration
integer

The total duration of all disclosed activities for an entity entered by the discloser.

dateCreated
string <date-time>

The timestamp when the entity record was created, in UTC format.

createdAt
required
string <date-time>

The timestamp when the entity record was created, in UTC format. \n\n NOTE: Required for migration

dateModified
string <date-time>

The timestamp when the entity record was modified, in UTC format.

createdBy
required
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

sourceId
required
string

For migration, use source ID (Disclosure Entity ID ) from legacy system.(e.g., ID00000594).

modifiedBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

required
Equity (object) or Editorial (object) or Consulting (object) or IP (object) or Divestiture (object) or Travel (object) or Prizes (object) or Other (object) or External (object) or VentureCapital (object) or Board (object) or VisitingScholar (object) or InKind (object)

Denotes Compensation of a disclosure type

{
  • "entityId": "string",
  • "entitySource": "DisclosureProfile",
  • "entityHrn": "string",
  • "writeInEntity": {
    },
  • "disclosureTypeId": "string",
  • "entityInformation": {
    },
  • "totalValue": 0,
  • "totalDuration": 0,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "sourceId": "string",
  • "modifiedBy": "string",
  • "compensation": {
    }
}

UploadManagementPlan

Array of objects (DocumentRef)

Document for upload management plan.

lastAcceptedDate
required
string <date-time>

Date and time about the management plan acceptance by the disclosure.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "draftManagementPlan": [
    ],
  • "lastAcceptedDate": "2019-08-24T14:15:22Z",
  • "actionLogFormData": [
    ]
}

Withdraw

Array of objects (DocumentRef)

Supporting document in form while executing withdraw action.

comments
required
string

Comments added for discarding the plan.

Array of objects (ActionLogFormData)

Details of the form data for logging action details.

{
  • "supportingDocuments": [
    ],
  • "comments": "string",
  • "actionLogFormData": [
    ]
}

WriteInEntityResource

writeInEntityName
string

The name of the write in entity. This field is used when the entity cannot be selected from the organization list.

entityIsPublic
boolean

Indicates whether the disclosure entity is public. The values are true or false.

entityIsForeign
boolean

Indicates whether the disclosure entity is foreign. The values are true or false.

{
  • "writeInEntityName": "string",
  • "entityIsPublic": true,
  • "entityIsForeign": true
}

WriteInEntitiesListResponse

object (Pagination)

Describes pagination support.

Array of objects (ResponseFilters)

List of filters that were applied.

Array of objects (ResponseSorts)

List of sorts that were applied.

object
Array of objects
{
  • "pagination": {
    },
  • "filters": [
    ],
  • "sorts": [
    ],
  • "links": {
    },
  • "data": [
    ]
}

WriteInEntity

writeInEntityName
required
string

The name of the write in entity. This field is used when an entity cannot be selected in the organization list.

entityIsPublic
boolean

Indicates whether the disclosure entity is public. The values are true or false.

entityIsForeign
boolean

Indicates whether the disclosure entity is foreign. The values are true or false.

{
  • "writeInEntityName": "string",
  • "entityIsPublic": true,
  • "entityIsForeign": true
}

Core Models

BulkImportOrganizations

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects
{
  • "idFieldName": "string",
  • "data": [
    ]
}

BulkImportPersons

idFieldName
string (IdFieldName) ^(id|sourceIdentifier)$

Name of the reference key in the actual object for import. Value must be id.

  • For bulk import persons/contacts : personId

  • For bulk import organizations : organizationId

Array of objects
{
  • "idFieldName": "string",
  • "data": [
    ]
}

Certification

hrn
string^hrn:hrs:certification:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

id
string <= 155 characters

ID of the certification record.

object

Details of the disclosure for whom the certification was created.

name
string

Name of the certification.

eventType
string

Type of an event (IRB Submission | Grants JIT).

object (PersonRef)
Array of objects
certificationType
string
Enum: "Research" "Non-Research"

Type of certification (e.g., Research, Non-Research).

{
  • "hrn": "string",
  • "id": "string",
  • "discloser": {
    },
  • "name": "string",
  • "eventType": "string",
  • "principalInvestigator": {
    },
  • "assignedReviewer": [
    ],
  • "certificationType": "Research"
}

Disclosure Profile

hrn
string^hrn:hrs:disclosureprofile:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

id
string

Unique identifier of the disclosure profile.

profileId
integer

The ID of the disclosure entity profile associated with the disclosure entity.

name
string

Name of the disclosure profile (e.g., Disclosure Profile for John).

object

The details of a disclosed person.

object

The details of a discloser proxy.

requiresProfileUpdate
boolean

Indicates whether the discloser profile requires an update. The values are true or false.

dateCreated
string <date-time>

The timestamp when profile was created.

dateModified
string <date-time>

The timestamp when profile was last modified.

hasAcceptedTrainingMaterials
boolean

Indicates whether the discloser has accepted training materials in the disclosure profile. The values are true or false.

hasOutsideActivities
boolean

Indicates whether the discloser has any outside activities or financial interests to disclose. The values are true or false.

isActive
boolean

Indicates whether the disclosure profile is active. The values are true or false. By default, the profile is active. If set to False, then it indicates the profile is deactivated.

projectStateId
string

The state of the disclosure profile (Active | InActive | ActionRequired | NoActionRequired).

previousProjectStateId
string

The previous state of the project before the current one.

workflowState
string

The disclosure profile's current state.

firstName
string

The given first name of a discloser profile.

lastName
string

The surname or family name of the discloser profile.

object

Contact information of the person.

object

Details of the Organization.

Array of objects

List of categories for which training has been accepted.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

disclosureProfileHrn
string^hrn:hrs:disclosureprofile:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_uniqueid.

hasVentureCaptalEnableAsEquityDisclosuer
boolean

Indicates whether to enable venture capital in equity type disclosure. The values are true or false.

isApplicableToAllPersonnel
boolean

Indicates whether discloser profile applies to all personnel. The values are true or false.

managementPlanCount
integer

The number of management plans associated with the profile.

stateLastUpdated
string <date-time>

The timestamp when last time the state was last updated.

daysInCurrentState
integer

The days since no state has changed

projectStateDisplayName
string

Label/name of the project state ID.

profileUpdatedDate
string <date-time>

The timestamp when the disclosure profile was most recently updated.

active
boolean

Indicates whether the project appears in picklists. The values are true or false.

Array of objects (SmartformStep)

Active Flex steps for disclosure profile configured in Step Flex Settings.

researchTrainingDate
string <date-time>

The date the research training was completed.

isLastTrainingCompleted
boolean

Indicates whether the most recent required training has been completed. The values are true or false.

object^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects

Tags associated with the disclosure profile.

Array of objects (UpdateDisclosureEntity)
stateLastUppdated
string <date-time>

The last time the profile state was updated.

Array of objects

Version history of the disclosure profile.

isCustomPropertiesModified
boolean

Indicates if any custom fields have been modified. The values are true or false.

discloserDisplayName
string

Full name of the discloser.

emailDisplayName
string <email>

Displayed email address of the discloser.

isSfUpdated
boolean

Indicates if Salesforce (or similar system) has been updated. The values are true or false.

isCompleteProxyCompleted
boolean

Whether the discloser proxy section has been fully completed. The values are true or false.

hasOutstandingPortfolioTasks
boolean

Indicates whether there are any outstanding portfolio review tasks. The values are true or false.

foreignTalentDescription
string

Notes or description regarding foreign talent disclosure.

hasApplicantOrParticipant
boolean

Indicates whether the discloser is an applicant or participant in related programs. The values are true or false.

hasActiveStartupPackage
boolean

Indicates whether the discloser has an active startup funding package. The values are true or false.

hasStartupCompanyIntellectual
boolean

Indicates whether the discloser has intellectual property in a startup. The values are true or false.

hasThresholdExceeded
boolean

Indicates whether any disclosure exceeds the dollar/time threshold. The values are true or false.

IsResolvePortfolioVisible
boolean

Indicates whether the "Resolve Portfolio" button is visible. The values are true or false.

IsDiscloserPresentInOffices
boolean

Indicates whether the discloser is assigned to any COI office. The values are true or false.

IsDiscloserHasCoia
boolean

True if discloser has a COI admin assigned. The values are true or false.

isUserIsAssignReviewer
boolean

Indicates whether the current user is assigned as a reviewer. The values are true or false.

currentUserHasAccessToDp
boolean

Indicates whethe the current user has access to view the disclosure profile. The values are true or false.

Array of objects

List of reviewers assigned to handle portfolio review tasks.

organisationName
string

Name of the organization.

email
string <email>

Primary email address of the discloser.

object

Custom key-value pairs defined for the profile.

object

Draft data version of the disclosure profile.

employerName
string

Employer name associated with the discloser.

secondaryUnitName
string

Secondary unit name, if applicable.

additionalUnitName
string

Additional unit name, if applicable.

organizationName
string

Name of the organization linked to the discloser.

isMpAssociatedEntityUpdated
boolean

Indicates whether any entity associated with a management plan has been updated. The values are true or false.

object

Metadata about training expiration and forced profile updates.

object

Custom field values saved in draft.

Array of objects

Dynamic form data organized by steps.

Array of objects

Draft entity disclosures associated with the profile.

{
  • "hrn": "string",
  • "disclosureHrn": {
    },
  • "id": "DP00000025",
  • "profileId": 0,
  • "name": "Disclosure Profile for Huron Administrator",
  • "discloser": {
    },
  • "discloserProxy": {
    },
  • "requiresProfileUpdate": true,
  • "dateCreated": "2023-04-14T11:55:33.020703Z",
  • "dateModified": "2025-05-07T06:31:50.250883Z",
  • "hasAcceptedTrainingMaterials": true,
  • "hasOutsideActivities": true,
  • "isActive": true,
  • "projectStateId": "ActionRequired",
  • "previousProjectStateId": "NoActionRequired",
  • "workflowState": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "contactInformation": {
    },
  • "employer": {
    },
  • "hasAcceptedData": [
    ],
  • "createdBy": {
    },
  • "disclosureProfileHrn": "string",
  • "hasVentureCaptalEnableAsEquityDisclosuer": true,
  • "isApplicableToAllPersonnel": true,
  • "managementPlanCount": 0,
  • "stateLastUpdated": "2019-08-24T14:15:22Z",
  • "daysInCurrentState": 0,
  • "projectStateDisplayName": "string",
  • "profileUpdatedDate": "2019-08-24T14:15:22Z",
  • "active": true,
  • "smartformSteps": [
    ],
  • "researchTrainingDate": "2025-03-22T11:36:16.893619Z",
  • "isLastTrainingCompleted": false,
  • "disclosureProxyHrn": {
    },
  • "tags": [
    ],
  • "disclosureEntities": [
    ],
  • "stateLastUppdated": "2025-04-07T06:02:46.15192Z",
  • "versions": [
    ],
  • "isCustomPropertiesModified": true,
  • "discloserDisplayName": "Huron Administrator",
  • "emailDisplayName": "admin@hcg.com",
  • "isSfUpdated": true,
  • "isCompleteProxyCompleted": false,
  • "hasOutstandingPortfolioTasks": true,
  • "foreignTalentDescription": "ggggdfgdfg gg gg aa aaa",
  • "hasApplicantOrParticipant": true,
  • "hasActiveStartupPackage": true,
  • "hasStartupCompanyIntellectual": true,
  • "hasThresholdExceeded": true,
  • "IsResolvePortfolioVisible": false,
  • "IsDiscloserPresentInOffices": false,
  • "IsDiscloserHasCoia": true,
  • "isUserIsAssignReviewer": true,
  • "currentUserHasAccessToDp": true,
  • "portfolioReviewTaskAssignedTo": [
    ],
  • "organisationName": "Huron Consulting Group",
  • "email": "admin@hcg.com",
  • "customProperties": { },
  • "dpDraftData": {
    },
  • "employerName": "",
  • "secondaryUnitName": "",
  • "additionalUnitName": "",
  • "organizationName": "",
  • "isMpAssociatedEntityUpdated": true,
  • "gracePeriodData": {
    },
  • "draftCustomData": {
    },
  • "stepFormData": [
    ],
  • "entityDraftData": [
    ]
}

Management Plan

name
required
string

Name of the management plan supplied at creation.

required
object (DocumentRef)
{
  • "name": "string",
  • "planDocument": {
    }
}

Retrospective Review

id
string <= 55 characters

An identifier generated during creation of the retrospective review. Each ID is unique within the tenant.

required
object

Details of the discloser.

NOTE: For v10 to v12 migration, the expected value is only the HRN of discloser.

name
required
string

Name of the retrospective review.

findingsOfReview
string

Details of a particular retrospective review.

reasonForReview
string

Details of the reason why retrospective review was performed.

methodology
string

Details for explaining the retrospective review (e.g., document reviewed).

discoveryDate
required
string <date-time>

Date that the institution reached a conclusion that non-compliance had occurred.

NOTE: Only past dates are valid.

Array of objects (DocumentRef)

Details of the supporting documents.

NOTE: For V10 to V12 migration, the expected value is only hrn of documents.

Array of objects (TriggeringEventDetail)

Details of the related projects.

NOTE: For V10 to V12 migration, the expected value is only the hrn of projects.

Array of objects (Entities)

Details of the conflicting entities.

NOTE: For V10 to V12 migration, the expected value is only the HRN of Entities.

projectStateId
string

State identifier of the retrospective review project (e.g., InReview).

previousProjectStateId
string

State identifier of the previous retrospective review project.

NOTE: For V10 to V12 migration, previous project state is not necessary.

Array of objects (SubmitRetrospectiveReview)

Details of Submit retrospective review Action.

Array of objects (SubmitMitigationPlan)

Details of Submit Mitigation Plan Action.

Array of objects (PersonRef)

Details of the assigned reviewer.

NOTE: For V10 to V12 migration, the expected value is only the hrn of assigned reviewer.

isMigrated
boolean

Indicates whether retrospective review record is migrated. The values are true or false. Set the value to TRUE for migration. This is a required field for V10 to V12 migration and is only used for migration.

dateCreated
string <date-time>

Date retrospective review record was created.

This field is used only for V10 to V12 migration.

dateModified
string <date-time>

The timestamp indicating the last time a retrospective review record was modified.

This field is used only for V10 to V12 migration.

createdBy
string^hrn:hrs:persons:[0-9]+$

Huron Resource Name (HRN), a system generated unique value with the following structure hrn:hrs:resource_type:resource_id.

Array of objects (SmartformStep)

Active Flex steps for retrospective review configured in Step Flex Settings.

{
  • "id": "string",
  • "discloser": {
    },
  • "name": "string",
  • "findingsOfReview": "string",
  • "reasonForReview": "string",
  • "methodology": "string",
  • "discoveryDate": "2021-03-30T10:05:30.000Z",
  • "supportingDocuments": [
    ],
  • "relatedProjects": [
    ],
  • "conflictingEntities": [
    ],
  • "projectStateId": "string",
  • "previousProjectStateId": "string",
  • "submitRetrospectiveReview": [
    ],
  • "submitMitigationPlan": [
    ],
  • "assignReviewer": [
    ],
  • "isMigrated": true,
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateModified": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "smartformSteps": [
    ]
}

Reference Models

Document

<SchemaDefinition schemaRef="#/components/schemas/DocumentRef" />

HrnRef

#

Person

<SchemaDefinition schemaRef="#/components/schemas/Person" />