Plugin API

Hierarchy

  • SurveyApi

Index

Methods

Methods

create

  • create(surveyName: string, surveyDescription: string, savedQueryUuid: string, responsibilityAttributePersistentName: string, authorId: number): boolean

  • Create new survey with given name and description base on stored query and responsibility attribute

    Parameters

    • surveyName: string

      Name of the survey

    • surveyDescription: string

      Description of the survey

    • savedQueryUuid: string

      UUID of the saved query for which the survey should be created

    • responsibilityAttributePersistentName: string

      Persistent name of the responsibility attribute. Used for determining the user to which the survey will be sent.

    • authorId: number

      Id of the user who should be set as the author of the survey

    Returns boolean

    Whether the survey was successfully created or not

createSurvey

  • createSurvey(surveyName: string, surveyDescription: string, savedQueryUuid: string, responsibilityAttributePersistentName: string): boolean

  • Create new survey with given name and description base on stored query and responsibility attribute

    deprecated

    This will only work in directly executed scripts (A script using Api.registerExecution and executed via the UI, not scheduled). Generally using SurveyApi.create should be preferred.

    Parameters

    • surveyName: string

      Name of the survey

    • surveyDescription: string

      Description of the survey

    • savedQueryUuid: string

      UUID of the saved query for which the survey should be created

    • responsibilityAttributePersistentName: string

      Persistent name of the responsibility attribute. Used for determining the user to which the survey will be sent.

    Returns boolean

    Whether the survey was successfully created or not

Legend

Generated using TypeDoc