Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ApiV2

Index

Constructors

constructor

Methods

container

  • container(containerId: string): object
  • Parameters

    • containerId: string

    Returns object

    • breadcrumbs: function
      • breadcrumbs(__namedParameters: object): Promise<any>
      • Parameters

        • __namedParameters: object
          • containerType: string
          • objectId: undefined | string
          • objectType: undefined | string

        Returns Promise<any>

    • forms: object
      • get: function
        • get(__namedParameters?: object): Promise<any>
        • Parameters

          • Default value __namedParameters: object = {}
            • fields: undefined | string
            • queryBy: undefined | string

          Returns Promise<any>

form

  • form(formId: string, containerId: string): object
  • Parameters

    • formId: string
    • containerId: string

    Returns object

    • entry: function
      • entry(entryId: string): object
      • Parameters

        • entryId: string

        Returns object

        • create: function
          • create(__namedParameters: object): undefined | Promise<any>
          • Parameters

            • __namedParameters: object
              • mode: string
              • values: object

            Returns undefined | Promise<any>

        • evaluate: function
          • evaluate(__namedParameters: object): Promise<any>
          • Parameters

            • __namedParameters: object
              • canceller: Function
              • mode: string
              • values: object

            Returns Promise<any>

        • get: function
          • get(): undefined | Promise<any>
        • init: function
          • init(): undefined | Promise<any>
        • patch: function
          • patch(__namedParameters: object): undefined | Promise<any>
          • Parameters

            • __namedParameters: object
              • values: object

            Returns undefined | Promise<any>

        • update: function
          • update(__namedParameters: object): undefined | Promise<any>
          • Parameters

            • __namedParameters: object
              • values: object

            Returns undefined | Promise<any>

    • entries: object
      • groups: function
        • groups(__namedParameters: object): Promise<any>
        • Parameters

          • __namedParameters: object
            • count: number
            • filters: string
            • start: number

          Returns Promise<any>

    • structure: object
      • get: function
        • get(): Promise<any>

object

  • object(objectId: string, containerId: string): object
  • Parameters

    • objectId: string
    • containerId: string

    Returns object

    • actions: object
      • evaluate: function
        • evaluate(__namedParameters: object): Promise<any>
        • Parameters

          • __namedParameters: object
            • actionId: string
            • objectIds: any[]
            • parentId: string
            • scheduled: boolean

          Returns Promise<any>

      • get: function
        • get(params: any): Promise<any>

sessionData

  • sessionData(): Promise<any>
  • Fetches the session data for the logged in user

    Returns Promise<any>

workflow

  • workflow(workflowId: string, containerId: string): object
  • Parameters

    • workflowId: string
    • containerId: string

    Returns object

    • entry: function
      • entry(entryId?: undefined | string): object
      • Parameters

        • Optional entryId: undefined | string

        Returns object

        • create: function
          • create(__namedParameters: object): Promise<any>
          • Parameters

            • __namedParameters: object
              • entry: object

            Returns Promise<any>

        • evaluate: function
          • evaluate(__namedParameters: object): Promise<any>
          • Parameters

            • __namedParameters: object
              • entry: object
              • stepId: string

            Returns Promise<any>

        • get: function
          • get(stepId?: undefined | string): Promise<any>
          • Parameters

            • Optional stepId: undefined | string

            Returns Promise<any>

        • init: function
          • init(): undefined | Promise<any>
        • update: function
          • update(__namedParameters: object): Promise<any>
          • Parameters

            • __namedParameters: object
              • action: string
              • entry: object
              • nextStepId: string
              • stepId: string

            Returns Promise<any>

    • structure: object
      • get: function
        • get(): Promise<any>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc