Skip to main content
GET
Get one rule

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "scopes": Include equipment and user applicability scopes (non-deleted).
  • "technical-installations": Include the concerned technical installations (id, ref, name).
  • "counts": Adds _count of linked compliances, scopes, installations and responsibilities.
  • "actions-info": Adds actions { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }.
  • "responsibles": Adds responsibles - the users responsible for this element.
Available options:
scopes,
technical-installations,
counts,
actions-info,
responsibles

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
Required string length: 1 - 200
description
string | null
required
Maximum string length: 2000
type
enum<string>
required
Available options:
preventive,
training_session,
training_exercise,
training_qualification
workflowType
enum<string>
required
Available options:
calendar,
regulatory
complianceType
enum<string>
required
Available options:
registry,
maintenance
rrule
string | null
required
Required string length: 1 - 500
rruleGap
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
validityDuration
string | null
required
Pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$
thresholdPercent
integer | null
required
Required range: 0 <= x <= 100
providerTypes
enum<string>[]
required
Available options:
qualified_technician,
approved_organization,
training_provider
siteScopes
object[]
required
formTemplateId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
libraryRuleId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
libraryVersion
integer | null
required
Required range: 0 < x <= 9007199254740991
mainTechnicalInstallationId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
equipmentScopes
object[]
userScopes
object[]
technicalInstallations
object[]
_count
object
actions
object
responsibles
object[]