API docs by Redocly

Organi OH (Maintenance) API (1.5.27)

Download OpenAPI specification:

API for managing maintenance contracts and items (Onderhoudscontracten).

oh

Get all maintenance contracts

Retrieves all maintenance contracts from the system.

Responses

Response Schema: application/json
Array
maintenanceContractId
string
companyId
string
accountId
string
addressId
string
sequence
number
contractId
string
description1
string or null
description2
string or null
statusId
number
jiraName
string
pkey
string
lastUpdate
string <date-time>
Array of objects (OhMaintenanceContractDetail)

Response samples

Content type
application/json
[
  • {
    }
]

Get maintenance contracts by Jira name

Retrieves maintenance contracts filtered by a specific Jira name.

query Parameters
filter
required
string

JSON filter object (e.g., '{"jiraName": "PROJ-123"}')

Responses

Response Schema: application/json
Array
maintenanceContractId
string
companyId
string
accountId
string
addressId
string
sequence
number
contractId
string
description1
string or null
description2
string or null
statusId
number
jiraName
string
pkey
string
lastUpdate
string <date-time>
Array of objects (OhMaintenanceContractDetail)

Response samples

Content type
application/json
[
  • {
    }
]

Get all maintenance items

Retrieves all available maintenance items.

Responses

Response Schema: application/json
Array
maintenanceItemId
string
companyId
string
itemId
string
group1
string or null
group2
string or null
group3
string or null
descriptionNl
string or null
descriptionFr
string or null
descriptionEn
string or null
descriptionDe
string or null
statusId
string
pkey
string
lastUpdate
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Get maintenance item by ID

Retrieves a specific maintenance item by its item ID.

path Parameters
id
required
string

The item ID.

Responses

Response Schema: application/json
maintenanceItemId
string
companyId
string
itemId
string
group1
string or null
group2
string or null
group3
string or null
descriptionNl
string or null
descriptionFr
string or null
descriptionEn
string or null
descriptionDe
string or null
statusId
string
pkey
string
lastUpdate
string <date-time>

Response samples

Content type
application/json
{
  • "maintenanceItemId": "string",
  • "companyId": "string",
  • "itemId": "string",
  • "group1": "string",
  • "group2": "string",
  • "group3": "string",
  • "descriptionNl": "string",
  • "descriptionFr": "string",
  • "descriptionEn": "string",
  • "descriptionDe": "string",
  • "statusId": "string",
  • "pkey": "string",
  • "lastUpdate": "2019-08-24T14:15:22Z"
}

admin

Update contracts from Ordas

Triggers a manual update of maintenance contracts from the Ordas system.

Request Body schema: application/json
required
jiraName
string
since
string <date-time>

Responses

Response Schema: application/json
success
boolean
message
string
count
number

Request samples

Content type
application/json
{
  • "jiraName": "string",
  • "since": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0
}

Update all contracts from Ordas

Triggers a full update of all maintenance contracts from the Ordas system.

Responses

Response Schema: application/json
success
boolean
message
string
count
number

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0
}