Skip to main content
PATCH
/
rules
/
v2
/
bo
/
library
/
training-exercise
/
{ruleId}
Update library training exercise rule
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/rules/v2/bo/library/training-exercise/{ruleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "name": "Annual Safety Check",
  "description": "This rule requires an annual safety check for all installations.",
  "links": [
    {
      "name": "Rule Details",
      "url": "https://example.com/rule-details"
    }
  ],
  "rrule": "FREQ=YEARLY;BYMONTH=12;BYMONTHDAY=1",
  "workflowType": 1,
  "complianceType": 1,
  "siteScopes": [
    {
      "categories": [
        1
      ],
      "classifications": [
        "ERP"
      ],
      "types": [
        "J"
      ],
      "privateCapacity": 100,
      "privateCapacityOperator": ">="
    }
  ]
}
'
{
  "data": {
    "id": 1,
    "name": "Annual Safety Check",
    "description": "This rule requires an annual safety check for all installations.",
    "sourceType": 1,
    "type": 1,
    "links": [
      {
        "name": "Rule Details",
        "url": "https://example.com/rule-details"
      }
    ],
    "rrule": "FREQ=YEARLY;BYMONTH=12;BYMONTHDAY=1",
    "rruleGap": 30,
    "workflowType": 1,
    "complianceType": 1,
    "companyTypes": [
      1
    ],
    "technicalInstallationIds": [
      1,
      2,
      3
    ],
    "siteScopes": [
      {
        "categories": [
          1
        ],
        "classifications": [
          "ERP"
        ],
        "types": [
          "J"
        ],
        "privateCapacity": 100,
        "privateCapacityOperator": ">="
      }
    ],
    "deletedAt": "2024-12-15T10:00:00.000Z",
    "archivedAt": "2024-12-10T10:00:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Path Parameters

​
ruleId
integer
required

Unique identifier of the rule.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Body

application/json

Details required to update library training exercise rule

​
name
string

Name of the rule.

Required string length: 1 - 250
Example:

"Annual Safety Check"

​
description
string

Description of the rule.

Required string length: 1 - 2500
Example:

"This rule requires an annual safety check for all installations."

​
links
object[]
​
rrule
string

Recurrence rule for the rule.

Required string length: 1 - 300
Example:

"FREQ=YEARLY;BYMONTH=12;BYMONTHDAY=1"

​
workflowType
integer

Type of workflow (1: calendar-based, 2: regulatory).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
complianceType
integer

Type of compliance (1: register, 2: maintenance).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
siteScopes
object[]

List of site scopes to associate with the rule.

Response

200 - application/json

The library training exercise rule has been updated

​
data
object
required