Skip the next scheduled run
curl --request PATCH \
--url https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule \
--header 'Content-Type: application/json' \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '{
"id": 123
}'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule"
payload = { "id": 123 }
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-API-KEY': '<api-key>',
'OW-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({id: 123})
};
fetch('https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"OW-KEY: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule"
payload := strings.NewReader("{\n \"id\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": 123\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"title": "<string>",
"status": "<string>",
"frequency": "<string>",
"frequencyDays": 123,
"plannedMaintenanceTemplateId": 123,
"startDate": "2023-11-07T05:31:56Z",
"locationId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"scheduleId": "<string>",
"basedOn": "<string>",
"createConfig": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"monthConfig": {},
"weekDays": [
"<string>"
],
"idealVisitTime": "<string>",
"nextScheduled": "2023-11-07T05:31:56Z",
"nextToNextScheduled": "2023-11-07T05:31:56Z",
"nte": 123,
"supplierFacilityId": 123,
"supplierContractId": "<string>",
"supplierContractDocuments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"triggerConditionId": 123,
"meterTypeId": 123,
"meterId": 123,
"assetTypeId": 123,
"assetId": 123,
"additionalInfo": "<string>",
"location": {
"name": "<string>",
"isActive": true,
"locationTypeId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"storeId": "<string>",
"brandId": 123,
"brandAssetGroupId": 123,
"allAssetCount": 123,
"description": "<string>",
"openDate": "2023-11-07T05:31:56Z",
"closeDate": "2023-11-07T05:31:56Z",
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"phoneNumber": "<string>",
"locationTypeDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<string>"
}
],
"notes": "<string>",
"notesNonFormatted": "<string>",
"internalNotes": "<string>",
"images": [
"<string>"
],
"internalAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"primaryContactsEmails": [
"<string>"
],
"facilityInChargeEmails": [
"<string>"
],
"sendApprovedInvoicesToEmails": [
"<string>"
],
"sendApprovedQuotesToEmails": [
"<string>"
],
"storeAssociateEmails": [
"<string>"
],
"fieldTechEmails": [
"<string>"
],
"timeZoneId": "<string>",
"hasPresetAssetUUID": true,
"regionId": 123,
"region": {
"name": "<string>",
"buyerCompanyId": 123,
"hasChildren": true,
"isDeleted": true,
"id": 123,
"hierarchyName": "<string>",
"parentId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"purchaseOrderPrefix": "<string>",
"isLeased": true,
"leaseStartDate": "2023-11-07T05:31:56Z",
"leaseEndDate": "2023-11-07T05:31:56Z",
"taxRate": "<string>",
"customFieldDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<string>"
}
],
"buildingWarrantyStartDate": "2023-11-07T05:31:56Z",
"buildingWarrantyExpirationDate": "2023-11-07T05:31:56Z",
"buildingWarrantyProblemTypeIds": [
123
],
"buildingWarrantyServiceProviderId": 123,
"invoicesBillTo": {
"billTo": "<string>",
"serviceAddress": {}
},
"countryCode": "<string>",
"totalWOCount": 123,
"totalNotClosedWOCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deletedAt": "2023-11-07T05:31:56Z"
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Planned Maintenance
Skip the next scheduled run
Advances the schedule past its next scheduled run. The body is parsed by service.constructPlannedMaintenanceScheduleToUpdateNextSchedule, whose source was not provided; the schedule id is the observed requirement — the schema here is ABRIDGED. Not rate limited.
PATCH
/
v1
/
buyer
/
pm
/
planned_maintenance_schedules
/
skip_schedule
Skip the next scheduled run
curl --request PATCH \
--url https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule \
--header 'Content-Type: application/json' \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '{
"id": 123
}'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule"
payload = { "id": 123 }
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-API-KEY': '<api-key>',
'OW-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({id: 123})
};
fetch('https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"OW-KEY: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule"
payload := strings.NewReader("{\n \"id\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/buyer/pm/planned_maintenance_schedules/skip_schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": 123\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"title": "<string>",
"status": "<string>",
"frequency": "<string>",
"frequencyDays": 123,
"plannedMaintenanceTemplateId": 123,
"startDate": "2023-11-07T05:31:56Z",
"locationId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"scheduleId": "<string>",
"basedOn": "<string>",
"createConfig": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"monthConfig": {},
"weekDays": [
"<string>"
],
"idealVisitTime": "<string>",
"nextScheduled": "2023-11-07T05:31:56Z",
"nextToNextScheduled": "2023-11-07T05:31:56Z",
"nte": 123,
"supplierFacilityId": 123,
"supplierContractId": "<string>",
"supplierContractDocuments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"triggerConditionId": 123,
"meterTypeId": 123,
"meterId": 123,
"assetTypeId": 123,
"assetId": 123,
"additionalInfo": "<string>",
"location": {
"name": "<string>",
"isActive": true,
"locationTypeId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"storeId": "<string>",
"brandId": 123,
"brandAssetGroupId": 123,
"allAssetCount": 123,
"description": "<string>",
"openDate": "2023-11-07T05:31:56Z",
"closeDate": "2023-11-07T05:31:56Z",
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"phoneNumber": "<string>",
"locationTypeDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<string>"
}
],
"notes": "<string>",
"notesNonFormatted": "<string>",
"internalNotes": "<string>",
"images": [
"<string>"
],
"internalAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"primaryContactsEmails": [
"<string>"
],
"facilityInChargeEmails": [
"<string>"
],
"sendApprovedInvoicesToEmails": [
"<string>"
],
"sendApprovedQuotesToEmails": [
"<string>"
],
"storeAssociateEmails": [
"<string>"
],
"fieldTechEmails": [
"<string>"
],
"timeZoneId": "<string>",
"hasPresetAssetUUID": true,
"regionId": 123,
"region": {
"name": "<string>",
"buyerCompanyId": 123,
"hasChildren": true,
"isDeleted": true,
"id": 123,
"hierarchyName": "<string>",
"parentId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"purchaseOrderPrefix": "<string>",
"isLeased": true,
"leaseStartDate": "2023-11-07T05:31:56Z",
"leaseEndDate": "2023-11-07T05:31:56Z",
"taxRate": "<string>",
"customFieldDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<string>"
}
],
"buildingWarrantyStartDate": "2023-11-07T05:31:56Z",
"buildingWarrantyExpirationDate": "2023-11-07T05:31:56Z",
"buildingWarrantyProblemTypeIds": [
123
],
"buildingWarrantyServiceProviderId": 123,
"invoicesBillTo": {
"billTo": "<string>",
"serviceAddress": {}
},
"countryCode": "<string>",
"totalWOCount": 123,
"totalNotClosedWOCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deletedAt": "2023-11-07T05:31:56Z"
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Autorisations
OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.
Corps
application/json
Abridged: verify exact accepted fields against the implementation.
Planned maintenance schedule id.
Réponse
Success.
Entity type marker, e.g. "PlannedMaintenanceSchedule".
Planned maintenance schedule. Abridged: hydrated template, trigger condition, meter, asset and run-log objects may also appear; status/frequency use custom serializations.
Show child attributes
Show child attributes
Options disponibles:
ok