POST api/reminder/remindme

Sets a reminder

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Reminders.Command.SetReminderCommandDataContract
NameDescriptionTypeAdditional information
Title

string

None.

Date

date

None.

Type

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

Priority

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

SnoozeCount

integer

None.

Data

Dictionary of string [key] and Object [value]

None.

ReferenceDate

date

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Title": "sample string 1",
  "Date": "2024-04-16T09:50:26.3430205Z",
  "Type": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Priority": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SnoozeCount": 3,
  "Data": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "ReferenceDate": "2024-04-16T09:50:26.3430205Z"
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

boolean

None.

ReportsProgress

boolean

None.

InitialStatusText

string

None.

JobReference

globally unique identifier

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "ea4723b0-89ac-4f29-9605-17686b59c0dc",
  "Success": true
}