Class Verifications

Verifications API request class Provides methods for interacting with verification-related endpoints

Hierarchy (View Summary)

Constructors

constructor

Properties

apiBaseUrl auth endpoint endpointSingleton

Methods

apiRequest create createVerifications delete exportHistoriqueTacheRecurrentes formatToCalendarEvents get getAll getById getCalendarEvents getPdfFile getProgression getTacheState getVerifications getVerificationsEquipementsTaches getVerificationsReponsesById getVerificationsReponsesNonConformes parseMetadata post put remove startVerification update

Constructors

constructor

Properties

apiBaseUrl

apiBaseUrl: string

auth

auth: Auth

endpoint

endpoint: string = '/api/verifications'

endpointSingleton

endpointSingleton: string = '/api/verification'

Methods

apiRequest

  • apiRequest(endpoint: string, method: string, data: any): Promise<any>

    Parameters

    • endpoint: string
    • method: string
    • data: any

    Returns Promise<any>

create

createVerifications

  • createVerifications(verifications: any[]): Promise<any>

    Create new verifications

    Parameters

    • verifications: any[]

      Array of verification data to create

    Returns Promise<any>

    Promise with the created verifications

delete

exportHistoriqueTacheRecurrentes

  • exportHistoriqueTacheRecurrentes(
        metadatas: Metadatas,
        fileExtension?: string,
        site?: null | string,
    ): Promise<any>

    Export recurring task history

    Parameters

    • metadatas: Metadatas

      Metadata for filtering

    • fileExtension: string = "xlsx"

      File extension (xlsx or csv)

    • site: null | string = null

      Optional site filter

    Returns Promise<any>

    Promise with export data

PrivateformatToCalendarEvents

get

  • get(
        endpoint: string,
        metadatas: Metadatas,
        query: null | { [key: string]: any },
    ): Promise<any>

    Parameters

    • endpoint: string
    • metadatas: Metadatas
    • query: null | { [key: string]: any }

    Returns Promise<any>

getAll

getById

getCalendarEvents

getPdfFile

  • getPdfFile(idVerification: number): Promise<any>

    Get PDF file for a verification

    Parameters

    • idVerification: number

      ID of the verification

    Returns Promise<any>

    Promise with PDF data

getProgression

  • getProgression(site: null | string, metadatas: Metadatas): Promise<any>

    Get verification progression data

    Parameters

    • site: null | string

      Optional site filter

    • metadatas: Metadatas

      Metadata for filtering

    Returns Promise<any>

    Promise with progression data

getTacheState

  • getTacheState(
        tacheId: number,
        site?: null | string,
        metadatas?: Metadatas,
    ): Promise<any>

    Get task state for unchecked items

    Parameters

    • tacheId: number

      Task ID

    • site: null | string = null

      Optional site filter

    • metadatas: Metadatas = ...

      Metadata for filtering

    Returns Promise<any>

    Promise with task state data

getVerifications

getVerificationsEquipementsTaches

  • getVerificationsEquipementsTaches(metadatas: Metadatas): Promise<any>

    Get verification equipment tasks

    Parameters

    Returns Promise<any>

    Promise with equipment tasks data

getVerificationsReponsesById

  • getVerificationsReponsesById(idVerification: number): Promise<any>

    Get verification responses by verification ID

    Parameters

    • idVerification: number

      ID of the verification

    Returns Promise<any>

    Promise with verification responses

getVerificationsReponsesNonConformes

  • getVerificationsReponsesNonConformes(metadatas: Metadatas): Promise<any>

    Get non-conforming verification responses

    Parameters

    Returns Promise<any>

    Promise with non-conforming responses

parseMetadata

post

put

remove

startVerification

  • startVerification(
        equipementId: number,
        tacheId?: number,
        uniquementMesTachesAffectes?: boolean,
    ): Promise<any>

    Start a verification process for an equipment

    Parameters

    • equipementId: number

      ID of the equipment to verify

    • OptionaltacheId: number

      Optional task ID

    • uniquementMesTachesAffectes: boolean = false

      Whether to only include tasks assigned to the current user

    Returns Promise<any>

    Promise with verification data

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods