Update Data Gathering Resources
Data Gathering resources that have been created can be modified using the Update DataGathering endpoint of the Janus API. This endpoint allows the calling system to update certain details of a Data Gathering resource. Certain details can only be updated during certain states of the Data Gatherer (for example, before it's been started by the Rater), please review the details below for more information.
| Property | Update Condition |
|---|---|
| directives | Can only update if the Rater has not yet started the assessment. |
| eventNotifications | Can update anytime. |
| host | Not yet implemented. |
| observationItemSets | Can only update if the Rater has not yet started the assessment. |
| resourceState | Can only update if the assessment is not yet completed by the Rater and has not been made invalid due to timeout. |
| retentionPolicy | Can update anytime. |
| runAs | Can update anytime. |
The following Resource State values can be set using the Update DataGathering endpoint:
| Resource State | Description |
|---|---|
| Active | Restores an assessment that has been Expired or Canceled back to an active state to be taken by the Rater. Cannot be used to make a Complete or Timed Out assessment active. |
| Canceled | Used to cancel an assessment. Differs from Expired only in the message the Rater will see when opening the assessment. |
| Expired | Used to expire an assessment. Differs from Canceled only in the message the Rater will see when opening the assessment. |