Owlytic API

Die Owlytic API ist um alles rund um das Thema Audit organisiert, einschließlich: Audit auslesen, Maßnahmen lesen und bearbeiten sowie Berichte.Die API verwendet Standardverben und gibt HTTP-Antwortcodes und JSON-kodierte Antworten zurück.

Um mit der Owlytic API zu beginnen, benötigst du zunächst ein Entwickler Kennwort. Dieses Kennwort erhältst du als zusätzlichen Service, gegen eine Gebühr, zu deinem Vertrag. Wir erstellen dir dann deinen persönlichen Token um die API nutzen zu können.

API Zugangsdaten anfragen: E-Mail

get audits

By passing in the appropriate options, you can get the audits from the system

GEThttps://api.paragon-dis.de/v1/audits/{companyId}

Authorization

bearerAuth

Path parameters

companyId*string

Id of company for audits that needs to be fetched

Example: "uEecmI05MoSvhzNFvaL6"

Response

200400401

Audits succesfully delivered

Body

application/json

auditIdstring (uuid)

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

auditNumberstring

Example: "HDKSND"

auditLanguagestring

Example: "English"

auditCreationDateinteger

Example: 1672698723

auditClosureDateinteger

Example: 1672698723

auditFocusstring

Example: "Development Process"

auditLevelstring

Example: "First-Party"

auditorDetailsAuditor (object)

auditCriteriastring

Example: "ISO 9001:2015"

auditProcessesarray of Process (object)

companyDataarray of Company (object)

auditScopeCoveragestring

Example: "56%"

auditResultstring

Example: "89%"

auditReportstring (url)

Example: "https://firebase.google.com/656783794092358ajsfhg86544"

Request

JavaScriptCurlPython

const response = await fetch('https://api.paragon-dis.de/v1/audits/{companyId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "auditId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "auditNumber": "HDKSND",
    "auditLanguage": "English",
    "auditCreationDate": 1672698723,
    "auditClosureDate": 1672698723,
    "auditFocus": "Development Process",
    "auditLevel": "First-Party",
    "auditorDetails": {
      "auditorFirstName": "Max",
      "auditorLastName": "Mustermann",
      "auditorEmail": "[e-mail]"
    },
    "auditCriteria": "ISO 9001:2015",
    "auditProcesses": [
      {
        "processId": "8G56hZ77",
        "processName": "Engineering"
      }
    ],
    "companyData": [
      {
        "companyName": "Mustermann AG",
        "companyEmail": "[e-mail]",
        "companyStreet": "Musterstraße 1",
        "companyCity": "Musterhausen",
        "companyZip": "A7654GG",
        "companyCountryCode": "DE"
      }
    ],
    "auditScopeCoverage": "56%",
    "auditResult": "89%",
    "auditReport": "https://firebase.google.com/656783794092358ajsfhg86544"
  }
]

get findings

By passing in the appropriate options, you can get the audits from the system

GEThttps://api.paragon-dis.de/v1/actions/{auditId}

Authorization

bearerAuth

Path parameters

auditId*string

Id of the audit for which the actions are to be fetched

Example: "Be9lqoMjNWdO3kpBltyv"

Response

200400401

Actions succesfully delivered

Body

application/json

actionIdstring

Example: "83483496"

auditIdstring

Example: "sdlkn34södkm4"

findingIsoChapterstring

Example: "7.2"

findingIsoHeaderstring

Example: "The company needs to establish a management review"

findingIsoRequirementsarray of string

findingTextstring

Example: "The company has a defined process see also Document xyz"

findingEvaluationstring

Example: "Major"

findingRiskEvaluationinteger

Example: 2

findingDateinteger

Example: 1672698723

Request

JavaScriptCurlPython

const response = await fetch('https://api.paragon-dis.de/v1/actions/{auditId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "actionId": "83483496",
    "auditId": "sdlkn34södkm4",
    "findingIsoChapter": "7.2",
    "findingIsoHeader": "The company needs to establish a management review",
    "findingIsoRequirements": [
      "text"
    ],
    "findingText": "The company has a defined process see also Document xyz",
    "findingEvaluation": "Major",
    "findingRiskEvaluation": 2,
    "findingDate": 1672698723
  }
]

Fill the action items of Owlytic Audit with responses

Adds answers to the three categories rootcauses, measures and proof of efficacy. Updates the status of the single action items to -in-work- One Action per Post

POSThttps://api.paragon-dis.de/v1/action/{auditId}

Authorization

bearerAuth

Path parameters

auditId*string

Id of the audit for which the actions are to be sent

Example: "Be9lqoMjNWdO3kpBltyv"

Body

application/json

Action to post

actionIdstring (uuid)

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

rootCausesarray of RootCause (object)

measuresarray of Measure (object)

proofsarray of ProofOfEfficacy (object)

Response

200400409

Action succesfully sent

Request

JavaScriptCurlPython

const response = await fetch('https://api.paragon-dis.de/v1/action/{auditId}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();