Resets a Task entity.

PUTRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.tasks.reset({
  id: 0,
});

Responses

200404

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "originalDueDate": "originalDueDate",
  "dueDate": "dueDate",
  "taskAttachments": [
    {
      "id": 0,
      "name": "name",
      "filename": "filename",
      "url": "url",
      "type": "type"
    }
  ],
  "taskCategories": [
    {
      "id": 0,
      "description": "description",
      "created": "created",
      "modified": "modified",
      "staffMemberOrganization": {
        "id": 0,
        "name": "name",
        "address": "address",
        "postalCode": "postalCode",
        "locality": "locality",
        "country": "country",
        "email": "email",
        "phoneNumber": "phoneNumber",
        "vatNumber": "vatNumber",
        "companyRegistrationNumber": "companyRegistrationNumber",
        "iban": "iban",
        "bic": "bic",
        "created": "created",
        "modified": "modified"
      }
    }
  ],
  "taskChangeNotes": [
    {
      "id": 0,
      "createdBy": "createdBy",
      "note": "note",
      "created": "created"
    }
  ],
  "taskChecklist": [
    {
      "id": 0,
      "description": "description",
      "created": "created",
      "modified": "modified"
    }
  ],
  "staffMemberSpecifications": [
    {
      "id": 0,
      "name": "name",
      "email": "email",
      "created": "created",
      "phoneNumber": "phoneNumber",
      "phoneNumberHome": "phoneNumberHome",
      "phoneNumberWork": "phoneNumberWork",
      "profilePicture": "profilePicture",
      "token": "token",
      "contactId": "contactId",
      "confirmedPushNotification": false,
      "allowedToChangeTasks": false,
      "modified": "modified",
      "taskCategory": {
        "id": 0,
        "description": "description",
        "created": "created",
        "modified": "modified",
        "staffMemberOrganization": {}
      },
      "staffMemberOrganization": {
        "id": 0,
        "name": "name",
        "address": "address",
        "postalCode": "postalCode",
        "locality": "locality",
        "country": "country",
        "email": "email",
        "phoneNumber": "phoneNumber",
        "vatNumber": "vatNumber",
        "companyRegistrationNumber": "companyRegistrationNumber",
        "iban": "iban",
        "bic": "bic",
        "created": "created",
        "modified": "modified"
      }
    }
  ],
  "created": "created",
  "title": "title",
  "description": "description",
  "done": false,
  "automatic": false,
  "dueTime": "00:00:00",
  "start": "start",
  "end": "end",
  "priority": 200,
  "status": "open",
  "amount": 0,
  "numOfPersons": 0,
  "numOfDays": 0,
  "numOfPets": 0,
  "hasNextReservation": false,
  "stale": false,
  "hasCustomDueDate": false,
  "hasCustomDueTime": false,
  "createdBy": "createdBy",
  "completedBy": "completedBy",
  "startedBy": "startedBy",
  "accommodationUnit": {
    "id": 0,
    "number": "number",
    "locale": "locale",
    "content": {
      "id": 0,
      "locale": "locale",
      "organization": {
        "id": 1000
      },
      "description": "description"
    },
    "features": [
      {
        "id": 1000
      }
    ],
    "reference": "reference",
    "latitude": "latitude",
    "longitude": "longitude",
    "public": true,
    "active": true,
    "availabilityEnabled": false,
    "available": true,
    "petsAllowed": true,
    "area": 0,
    "created": "created",
    "modified": "modified"
  },
  "taskLocation": {
    "id": 0,
    "description": "description",
    "created": "created",
    "modified": "modified"
  },
  "taskProject": {
    "id": 0,
    "title": "title",
    "description": "description",
    "created": "created",
    "modified": "modified"
  },
  "modified": "modified"
}

Response 404

Not found

application/json

Example 1

{
  "statusCode": 404,
  "description": "Not found",
  "errors": [
    "Not found"
  ]
}

Path parameters

• idnumberrequired

Returns

Schema shown for 200 · application/json

• idnumber
• titlestringoptional
• descriptionstringoptional
• donebooleanoptional
  Default: false
• automaticbooleanoptional
  Default: false
• originalDueDatestring
• dueDatestring
• dueTimestringoptional
  Default: "00:00:00"
• startstringoptional
• endstringoptional
• prioritynumberoptional
  Default: 200
• statusstringoptional
  Default: "open"
• amountnumberoptional
• numOfPersonsnumberoptional
• numOfDaysnumberoptional
• numOfPetsnumberoptional
• hasNextReservationbooleanoptional
  Default: false
• stalebooleanoptional
  Default: false
• hasCustomDueDatebooleanoptional
  Default: false
• hasCustomDueTimebooleanoptional
  Default: false
• createdBystringoptional
• completedBystringoptional
• startedBystringoptional
• accommodationUnitone of 1 variantsoptional
  Show 1 variant

  • AccommodationUnit2
    Show 16 properties

    • idnumber
    • numberstring
    • referencestringoptional
    • latitudestringoptional
    • longitudestringoptional
    • publicbooleanoptional
      Default: true
    • activebooleanoptional
      Default: true
    • availabilityEnabledbooleanoptional
      Default: false
    • availablebooleanoptional
      Default: true
    • petsAllowedbooleanoptional
    • areanumberoptional
    • localestring
    • createdstringoptional
    • modifiedstringoptional
    • contentAccommodationUnitContent2
      Show 4 properties

      • idnumber
      • descriptionstringoptional
      • localestring
      • organizationobject
        Show 1 property

        • idnumberoptional
    • featuresobject[]
      Show array — 1 property

      • idnumberoptional
• taskAttachmentsTaskAttachment[]
  Show array — 5 properties

  • idnumber
  • namestringoptional
  • filenamestringoptional
  • urlstringoptional
  • typestringoptional
• taskCategoriesTaskCategory[]
  Show array — 5 properties

  • idnumber
  • descriptionstring
  • createdstringoptional
  • modifiedstringoptional
  • staffMemberOrganizationone of 1 variantsoptional
    Show 1 variant

    • StaffMemberOrganization
      Show 14 properties

      • idnumber
      • namestring
      • addressstringoptional
      • postalCodestringoptional
      • localitystringoptional
      • countrystringoptional
      • emailstringoptional
      • phoneNumberstringoptional
      • vatNumberstringoptional
      • companyRegistrationNumberstringoptional
      • ibanstringoptional
      • bicstringoptional
      • createdstringoptional
      • modifiedstringoptional
• taskLocationone of 1 variantsoptional
  Show 1 variant

  • TaskLocation
    Show 4 properties

    • idnumber
    • descriptionstring
    • createdstringoptional
    • modifiedstringoptional
• taskChangeNotesTaskChangeNote[]
  Show array — 4 properties

  • idnumber
  • notestringoptional
  • createdBystring
  • createdstringoptional
• taskChecklistTaskChecklist[]
  Show array — 4 properties

  • idnumber
  • descriptionstring
  • createdstringoptional
  • modifiedstringoptional
• taskProjectone of 1 variantsoptional
  Show 1 variant

  • TaskProject
    Show 5 properties

    • idnumber
    • titlestringoptional
    • descriptionstringoptional
    • createdstringoptional
    • modifiedstringoptional
• staffMemberSpecificationsStaffMemberSpecification[]
  Show array — 15 properties

  • idnumber
  • namestring
  • emailstring
  • phoneNumberstringoptional
  • phoneNumberHomestringoptional
  • phoneNumberWorkstringoptional
  • profilePicturestringoptional
  • tokenstringoptional
  • contactIdstringoptional
  • confirmedPushNotificationbooleanoptional
    Default: false
  • allowedToChangeTasksbooleanoptional
    Default: false
  • createdstring
  • modifiedstringoptional
  • taskCategoryone of 1 variantsoptional
    Show 1 variant

    • TaskCategory
      Show 5 properties

      • idnumber
      • descriptionstring
      • createdstringoptional
      • modifiedstringoptional
      • staffMemberOrganizationone of 1 variantsoptional
        Show 1 variant

        • StaffMemberOrganization
  • staffMemberOrganizationone of 1 variantsoptional
    Show 1 variant

    • StaffMemberOrganization
      Show 14 properties

      • idnumber
      • namestring
      • addressstringoptional
      • postalCodestringoptional
      • localitystringoptional
      • countrystringoptional
      • emailstringoptional
      • phoneNumberstringoptional
      • vatNumberstringoptional
      • companyRegistrationNumberstringoptional
      • ibanstringoptional
      • bicstringoptional
      • createdstringoptional
      • modifiedstringoptional
• createdstring
• modifiedstringoptional