Dette dokumentet beskriver REN Sjekklist API. APIet omfatter sjekkpunkter og sjekklister, for bruk i skjemaer for slutt- og tilstandskontroll. Sjekkpunktene kan brukes som de er, eller som basis for selskapstilpassede sjekklister.
For generell informasjon om tilgang, autentisering og bruk av REN API, se Generelt.
Spørsmål om det faglige data-innholdet skal rettes til post@ren.no. |
Dato | Beskrivelse |
---|---|
19.02.2018 |
Første versjon. |
25.01.2019 |
Endringer i kapittelinndeling samt noen tekstuelle endringer. |
06.10.2019 |
Innføring av revisjoner for sjekklister. |
20.12.2019 |
Lagt til mulighet for å konfigurere hvilken type svar hvert sjekkpunkt skal ha (flervalg / tekst). |
Oppbygging
REN Sjekkliste API tilgjengeliggjør RENs sjekklister. En sjekkliste er definert som en liste sjekkpunkter gitt et anlegg (engelsk: facility) og og type sjekk (engelsk: assessment type). Hvert sjekkpunkt innholder informasjon om hva som skal sjekkes, om det eventuelt skal taes bilde for dokumentasjon, eventuell tidsperspektiv for uttbedring, samt veiledning og vedlikeholdsinstruksjoner.
Hvert sjekkpunkt er knyttet til en annleggsdel og kan være knyttet til en spesifikk komponent. Samme sjekkpunkt og annleggsdeler kan forekomme i flere ulike anlegg.
Det er kun mulighet for å lese sjekklister, så ved behov for lagring av resultatet av en kontroll må klienten selv lagre dette.
URL base path
Base path for REN Sjekkliste API er https://api.ren.no/public/checklist/rest
.
API-dokumentasjon
Dokumentasjonen over endepunktene og datastrukturene er generert og skrevet på engelsk. Du kan lese den samt prøve ut endepunktene i REN sin API Browser. Den dokumentasjonen er live-generert og gjenspeiler den versjon som faktisk kjører. Alternativt kan du fortsette å lese en statisk generert versjon her.
Resources
Checklist
Get facility checkpoints
GET /checkpoints/by-facilityid/{facilityid}
operation.deprecated |
Description
Deprecated, use GET /checkpoints/by-revision/{revision}/by-facilityid/{facilityid}
by revision. List all checkpoints for a specified facility. The returned checkpoints will likely belong to multiple checklists, and should normally be grouped by assessment type. You can call GET /facilities
first, to retrieve a list of facilities, with ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
facilityid |
A numeric ID that identifies the facility. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Checkpoint > array |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Get a checklist
GET /checkpoints/by-facilityid/{facilityid}/by-assessmenttype/{assessmenttype}
operation.deprecated |
Description
Deprecated, use GET /checkpoints/by-revision/{revision}/by-facilityid/{facilityid}/by-assessmenttype/{assessmenttype}
. List all checkpoints for a specified combination of facility and assessment type. The returned checkpoints naturally form a checklist. If the specified assessment type isn’t supported for the selected facility, then an empty list will be returned.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assessmenttype |
The assessment type for this checklist. See AssessmentType for details. |
enum (STATECONTROL_INSPECTION, STATECONTROL_SITEVISIT, STATECONTROL_TOPSITEVISIT, STATECONTROL_RENEWALSITEVISIT, FINALINSPECTION, RISKASSESSMENT, PLANNING, COMMISSIONING, SPECIFICATION, EXECUTION, HMESHA, UNKNOWN) |
Path |
facilityid |
A numeric ID that identifies the facility. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Checkpoint > array |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Get a checkpoint
GET /checkpoints/by-facilityid/{facilityid}/by-checkpointid/{checkpointid}
Description
Fetches information about a single checkpoint. The checkpoint is identified by the facility is belongs to, plus a numeric checkpoint ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
checkpointid |
A numeric ID that identifies the checkpoint. |
integer (int64) |
Path |
facilityid |
A numeric ID that identifies the facility. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Get facility checkpoints
GET /checkpoints/by-revision/{revision}/by-facilityid/{facilityid}
Description
List all checkpoints for a specified facility. The returned checkpoints will likely belong to multiple checklists, and should normally be grouped by assessment type. You can call GET /facilities
first, to retrieve a list of facilities, with ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
facilityid |
A numeric ID that identifies the facility. |
integer (int64) |
Path |
revision |
The catalog revision ID, or |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Checkpoint > array |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Get a checklist
GET /checkpoints/by-revision/{revision}/by-facilityid/{facilityid}/by-assessmenttype/{assessmenttype}
Description
List all checkpoints for a specified combination of facility and assessment type. The returned checkpoints naturally form a checklist. If the specified assessment type isn’t supported for the selected facility, then an empty list will be returned.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assessmenttype |
The assessment type for this checklist. See AssessmentType for details. |
enum (STATECONTROL_INSPECTION, STATECONTROL_SITEVISIT, STATECONTROL_TOPSITEVISIT, STATECONTROL_RENEWALSITEVISIT, FINALINSPECTION, RISKASSESSMENT, PLANNING, COMMISSIONING, SPECIFICATION, EXECUTION, HMESHA, UNKNOWN) |
Path |
facilityid |
A numeric ID that identifies the facility. |
integer (int64) |
Path |
revision |
The catalog revision ID, or |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Checkpoint > array |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Get facilities
GET /facilities
operation.deprecated |
Description
Deprecated, use GET /facilities/by-revision/{revision}
. Checkpoints are connected to facilities (norsk: anlegg) and components within facilities. This resource lists the top level facilities, without the related checkpoints.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Facility > array |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Get facilities
GET /facilities/by-revision/{revision}
Description
Checkpoints are connected to facilities (norsk: anlegg) and components within facilities. This resource lists the top level facilities, without the related checkpoints.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
revision |
The catalog revision ID, or |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Facility > array |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Get a facility
GET /facilities/by-revision/{revision}/{facilityid}
Description
Checkpoints are connected to facilities (norsk: anlegg) and components within facilities. This resource returns information about a single facility, without the related checkpoints.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
facilityid |
A numeric ID that identifies the facility. |
integer (int64) |
Path |
revision |
The catalog revision ID, or |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Get a facility
GET /facilities/{facilityid}
operation.deprecated |
Description
Deprecated, use GET /facilities/by-revision/{revision}/{facilityid}
. Checkpoints are connected to facilities (norsk: anlegg) and components within facilities. This resource returns information about a single facility, without the related checkpoints.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
facilityid |
A numeric ID that identifies the facility. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Get available revisions for REN checklists
GET /revisions
Description
When changes are made to the REN checklist content, a new revision of the checklist catalog will be made.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
< Revision > array |
Produces
-
application/json;charset=utf-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
renblad.bruker |
|
oauth2 |
renblad.bruker |
Download
Download PDF documents
GET /download/{facilityid}/{reporttype}/{assessmenttype}
Description
Can be used to download the actual checklists that are to be filled in, during assessment. Can also be used to download instructions and other documentation related to the assessment.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assessmenttype |
The assessment type for this checklist. See AssessmentType for details. |
enum (STATECONTROL_INSPECTION, STATECONTROL_SITEVISIT, STATECONTROL_TOPSITEVISIT, STATECONTROL_RENEWALSITEVISIT, FINALINSPECTION, RISKASSESSMENT, PLANNING, COMMISSIONING, SPECIFICATION, EXECUTION, HMESHA, UNKNOWN) |
Path |
facilityid |
A numeric ID that identifies the facility. |
integer (int64) |
Path |
reporttype |
The type of report the generate. See ReportType for details. |
enum (CHECKLIST, INSTRUCTIONS, INSTRUCTIONS_MAINTENANCE) |
Query |
option |
A list containing the IDs of optional checkpoints that should be included. Any optional checkpoint that isn’t mentioned here will be left out. |
< integer (int64) > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
default |
successful operation |
No Content |
Produces
-
application/pdf
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
rensystemer |
|
oauth2 |
rensystemer |
Definitions
AnswerType
Models the type of answer expected for a checkpoint. Valid values are:
-
MULTIPLECHOICE (norsk: Flervalg)
-
TEST (norsk: Tekstsvar)
Type : enum (MULTIPLECHOICE, TEXT)
AssessmentType
Models the type of assessment. Valid values are:
-
STATECONTROL_INSPECTION (norsk: Tilstandskontroll, inspeksjon)
-
STATECONTROL_SITEVISIT (norsk: Tilstandskontroll, befaring)
-
STATECONTROL_TOPSITEVISIT (norsk: Tilstandskontroll, toppbefaring)
-
STATECONTROL_RENEWALSITEVISIT (norsk: Tilstandskontroll, fornyelsesbefaring)
-
FINALINSPECTION (norsk: Sluttkontroll)
-
RISKASSESSMENT (norsk: Risikovurdering)
-
PLANNING (norsk: Prosjektering)
-
COMMISSIONING (norsk: Idriftsettelse)
-
SPECIFICATION (norsk: Spesifikasjon)
-
EXECUTION (norsk: Utførelse)
-
HMESHA (norsk: HMS-SHA Kontroll)
-
UNKNOWN (norsk: Ukjent)
Type : enum (STATECONTROL_INSPECTION, STATECONTROL_SITEVISIT, STATECONTROL_TOPSITEVISIT, STATECONTROL_RENEWALSITEVISIT, FINALINSPECTION, RISKASSESSMENT, PLANNING, COMMISSIONING, SPECIFICATION, EXECUTION, HMESHA, UNKNOWN)
Checkpoint
Models a single top level checkpoint. It might contain one or more sub-checkpoints. The same checkpoint can be valid for multiple facilities and assessment types.
Name | Description | Schema |
---|---|---|
answerType |
What type of answer is expected on this checkpoint. |
|
assessmentTypes |
The assessment types for which this checkpoint applies. |
< AssessmentType > array |
camera |
Indicates whether or not this checkpoint requires a photo as documentation. |
boolean |
cameraGuidance |
If 'camera' is true, this property might contain textual guidance for how the photo(s) should be taken. |
string |
componentId |
A numeric identifier for the component (within a facility part) that this checkpoint relates to. |
integer (int64) |
componentName |
A human readable name for the component (within a facility part) that this checkpoint relates to. |
string |
facilityPartId |
A numeric identifier for the facility part (norsk: anleggsdel) that this checkpoint relates to. |
integer (int64) |
facilityPartName |
A human readable name for the facility part (norsk: anleggsdel) that this checkpoint relates to. |
string |
guidance |
A textual guidance about how to perform this check. |
string |
id |
A unique numeric identifier. |
integer (int64) |
maintenanceMeasures |
A textual description about the measures that should be taken when correcting or maintaining. |
string |
name |
A human readable name. |
string |
option |
Declares if this checkpoint is optional or not. Will be false for most checkpoints. |
boolean |
primarySorting |
A primary number revealing the recommended sort order among checkpoints. |
integer (int64) |
renbladForCorrection |
A list of RENblad numbers. The referenced RENblads contain instructions for how to perform corrective actions. |
< string > array |
renbladForGuidance |
A list of RENblad numbers. The referenced RENblads contain guidance for how to perform this check. |
< string > array |
secondarySorting |
A secondary number revealing the recommended sort order among checkpoints. Should be consulted if 'primarySorting' is identical. |
integer (int64) |
subCheckpoints |
An optional list of sub-checkpoints. |
< SubCheckpoint > array |
timePerspectiveId |
A numeric identifier for the time perspective within which corrective actions should be taken. |
integer (int64) |
timePerspectiveName |
A human readable name for the time perspective within which corrective actions should be taken. |
string |
Facility
Models a single facility (norsk: anlegg). For each facility, one or more assessment forms are defined. Concrete checklists are typically based around a single facility.
Name | Description | Schema |
---|---|---|
assessmentTypes |
The assessment types for which this facility has checklists. |
< AssessmentType > array |
id |
A unique numeric identifier. |
integer (int64) |
name |
A human readable name. |
string |
ReportType
Models a type of (downloadable) report. Valid values are:
-
CHECKLIST The actual checklist that is to be filled out. (norsk: Skjema)
-
INSTRUCTIONS Instructions for filling out the checklist (during assessment). (norsk: Veiledning)
-
INSTRUCTIONS_MAINTENANCE Maintenance instructions. (norsk: Veiledning, vedlikehold)
Type : enum (CHECKLIST, INSTRUCTIONS, INSTRUCTIONS_MAINTENANCE)
Revision
Information about a checklist revision. At any given time, one single revision will be the latest revision.
Name | Description | Schema |
---|---|---|
activeFromDate |
string (date-time) |
|
description |
An optional description. |
string |
id |
A unique numeric identifier. |
integer (int64) |
name |
The revision name. |
string |
SubCheckpoint
Models a single sub-checkpoint. Sub-checkpoints are optional, and used for larger checkpoints where multiple thinsgs should be checked for the whole checkpoint to pass.
Name | Description | Schema |
---|---|---|
camera |
Indicates whether or not this checkpoint requires a photo as documentation. |
boolean |
cameraGuidance |
If 'camera' is true, this property might contain textual guidance for how the photo(s) should be taken. |
string |
guidance |
Textual guidance for how to this checkpoint should be fulfilled. |
string |
id |
A unique numeric identifier. |
integer (int64) |
name |
A human readable name. |
string |
sorting |
A numeric number revealing the recommended sort order among sub-checkpoints. |
integer (int64) |
Security
oauth2-password
A flow where an end user is required. Endpoints using this flow can provide personal customization and access to personal information.
Type : oauth2
Flow : password
Token URL : https://www.ren.no/auth/realms/www.ren.no/protocol/openid-connect/token
Name | Description |
---|---|
renblad.bruker |
Implies that role 'renblad.bruker' is required. |
rensystemer |
The default (and minimum) scope. |
oauth2-client
A flow where an end user is not involved. Endpoints using this flow will support full automation without any human intervention, but on the other hand cannot provide personal customization or access to personal information.
Type : oauth2
Flow : application
Token URL : https://www.ren.no/auth/realms/www.ren.no/protocol/openid-connect/token
Name | Description |
---|---|
renblad.bruker |
Implies that role 'renblad.bruker' is required. |
rensystemer |
The default (and minimum) scope. |