Class Incidents

Constructors

constructor

Methods

getIncident getIncidents

Constructors

constructor

Methods

getIncident

  • getIncident(
        context: "team" | "organisation" | "admin",
        contextId: number,
        activityId: number,
    ): Promise<Incident>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • activityId: number

      An activity identifier

    Returns Promise<Incident>

    • An incident

getIncidents

  • getIncidents(
        context: "team" | "organisation" | "admin",
        contextId: number,
        options?: {
            after?: string;
            before?: string;
            deleted?: boolean;
            ends_before?: string;
            id?: number | number[];
            order?: "asc" | "desc";
            page?: number;
            published?: boolean;
            reference?: string;
            size?: number;
            sort?: "createdAt" | "id" | "updatedAt";
            starts_after?: string;
            tag_bundle_id?: number;
            tag_id?: number;
            team_id?: number;
        },
    ): Promise<Incident[]>

  • Parameters

    • context: "team" | "organisation" | "admin"

      The point of view from where the request takes place

    • contextId: number

      Either a team, organisation or admin's id

    • Optionaloptions: {
          after?: string;
          before?: string;
          deleted?: boolean;
          ends_before?: string;
          id?: number | number[];
          order?: "asc" | "desc";
          page?: number;
          published?: boolean;
          reference?: string;
          size?: number;
          sort?: "createdAt" | "id" | "updatedAt";
          starts_after?: string;
          tag_bundle_id?: number;
          tag_id?: number;
          team_id?: number;
      }
      • Optionalafter?: string

        Return only activities ending after this datetime

      • Optionalbefore?: string

        Return only activities starting before this datetime

      • Optionaldeleted?: boolean

        Return only deleted activities

      • Optionalends_before?: string

        Return only activities ending before this datetime

      • Optionalid?: number | number[]

        A list of ids

      • Optionalorder?: "asc" | "desc"

        Default: "asc"

      • Optionalpage?: number

        Page number

      • Optionalpublished?: boolean

        Return only published activities

      • Optionalreference?: string

        A simple text search term, compared against the reference and reference description

      • Optionalsize?: number

        Items per page

      • Optionalsort?: "createdAt" | "id" | "updatedAt"

        Default: "id"

      • Optionalstarts_after?: string

        Return only activities starting after this datetime

      • Optionaltag_bundle_id?: number

        Return only activities with this tag bundle id

      • Optionaltag_id?: number

        Return only activities with this tag id

      • Optionalteam_id?: number

        Return only activities with this team id

    Returns Promise<Incident[]>

    • A list of incidents

Settings

Member Visibility

On This Page

Constructors
Methods