Patch an existing monitored item

Change existing monitoring for a specified item. Use this endpoint to update the monitoring frequency and next monitoring date.

Request
path Parameters
id
required
string <uuid>

The identifier describing the monitored item.

Request Body schema: application/json
monitoringInterval
string

If set, this will update the monitoring interval for this monitor.
NOTE: Continuous interval is only supported by the NPDB dataset at this time.

Enum: "Continuous" "Daily" "Weekly" "Monthly" "Yearly"
nextMonitoringDate
string <date-time>

If set, this will update the next date at which the data will be monitored.

triggerImmediateVerification
boolean

If set, this will trigger an immediate verification

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

patch/monitors/{id}
Request samples
application/json
{
  • "monitoringInterval": "Monthly",
  • "nextMonitoringDate": "2019-08-24T14:15:22Z",
  • "triggerImmediateVerification": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Dataset",
  • "monitoringInterval": "Monthly",
  • "nextMonitoringDate": "2019-08-24T14:15:22Z",
  • "lastMonitoringDate": "2019-08-24T14:15:22Z",
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "datasetType": "Sam",
  • "options": {
    },
  • "lastVerification": {
    }
}