Interface IBatchApi

Hierarchy

  • IBatchApi

Properties

copy: ((objCode, objID, updates, fields?, options?) => string)

Type declaration

    • (objCode, objID, updates, fields?, options?): string
    • Parameters

      • objCode: string
      • objID: string
      • updates: object
      • Optional fields: TFields
      • Optional options: string[]

      Returns string

count: ((objCode, query?) => string)

Type declaration

    • (objCode, query?): string
    • Parameters

      • objCode: string
      • Optional query: object

      Returns string

create: ((objCode, params, fields?) => string)

Type declaration

    • (objCode, params, fields?): string
    • Parameters

      • objCode: string
      • params: any
      • Optional fields: TFields

      Returns string

edit: ((objCode, objID, updates, fields?) => string)

Type declaration

    • (objCode, objID, updates, fields?): string
    • Parameters

      • objCode: string
      • objID: string
      • updates: any
      • Optional fields: TFields

      Returns string

editMultiple: ((objCode, updates, fields?) => string)

Type declaration

    • (objCode, updates, fields?): string
    • Parameters

      • objCode: string
      • updates: any[]
      • Optional fields: TFields

      Returns string

execute: ((objCode, objID, action, actionArgs?) => string)

Type declaration

    • (objCode, objID, action, actionArgs?): string
    • Parameters

      • objCode: string
      • objID: string
      • action: string
      • Optional actionArgs: object

      Returns string

get: ((objCode, objIDs, fields?) => string)

Type declaration

    • (objCode, objIDs, fields?): string
    • Parameters

      • objCode: string
      • objIDs: string | string[]
      • Optional fields: TFields

      Returns string

metadata: ((objCode?, fields?) => string)

Type declaration

    • (objCode?, fields?): string
    • Parameters

      • Optional objCode: string
      • Optional fields: TFields

      Returns string

namedQuery: ((objCode, query, queryArgs?, fields?) => string)

Type declaration

    • (objCode, query, queryArgs?, fields?): string
    • Parameters

      • objCode: string
      • query: string
      • Optional queryArgs: object
      • Optional fields: TFields

      Returns string

remove: ((objCode, objID, bForce?) => string)

Type declaration

    • (objCode, objID, bForce?): string
    • Parameters

      • objCode: string
      • objID: string
      • Optional bForce: boolean

      Returns string

report: ((objCode, query) => string)

Type declaration

    • (objCode, query): string
    • Parameters

      • objCode: string
      • query: object

      Returns string

request: ((path, params, fields?, method?) => string)

Type declaration

    • (path, params, fields?, method?): string
    • Parameters

      • path: string
      • params: any
      • Optional fields: TFields
      • Optional method: string

      Returns string

search: ((objCode, query?, fields?) => string)

Type declaration

    • (objCode, query?, fields?): string
    • Parameters

      • objCode: string
      • Optional query: object
      • Optional fields: TFields

      Returns string

Generated using TypeDoc