Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClassesDataService

Hierarchy

  • ClassesDataService

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = 'http://' + window.location.hostname + ':8081/hello/'

Private connectionMgr

connectionMgr: ConnectionManager

defaultHeaders

defaultHeaders: Headers = new Headers()

Methods

Private addingSessionIdHeader

  • addingSessionIdHeader(headers: Headers): void

  • Parameters

    • headers: Headers

    Returns void

configure

  • configure(body: any, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Configure the persisent class metadata.

    Parameters

    • body: any

      The metadata object to configure.

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

configureWithHttpInfo

  • configureWithHttpInfo(body: any, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Configure the persisent class metadata.

    Parameters

    • body: any

      The metadata object to configure.

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

create

  • create(body: any, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Create a new persistent object (insert new row).

    Parameters

    • body: any

      The object to be created.

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

createLang

  • createLang(lang: string, body: any, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Create a new persistent object (insert new row) with the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • body: any

      The object to be created.

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

createLangWithHttpInfo

  • createLangWithHttpInfo(lang: string, body: any, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Create a new persistent object (insert new row) with the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • body: any

      The object to be created.

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

createUUIDLang

  • createUUIDLang(lang: string, body: any, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Create a new persistent object (insert new row) with the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • body: any

      The object to be created.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

createUUIDLangWithHttpInfo

  • createUUIDLangWithHttpInfo(lang: string, body: any, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Create a new persistent object (insert new row) with the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • body: any

      The object to be created.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

createWithHttpInfo

  • createWithHttpInfo(body: any, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Create a new persistent object (insert new row).

    Parameters

    • body: any

      The object to be created.

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

delete

  • delete(uuid: string, classname: string, permanent?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Delete the object (row) from the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional permanent: boolean

      To permanent delete (destroy) the object or not. The destroyed objects will not be able to be recycled.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

deleteLang

  • deleteLang(lang: string, uuid: string, classname: string, permanent?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Delete the object (row) from the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional permanent: boolean

      To permanent delete (destroy) the object or not. The destroyed objects will not be able to be recycled.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

deleteLangWithHttpInfo

  • deleteLangWithHttpInfo(lang: string, uuid: string, classname: string, permanent?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Delete the object (row) from the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional permanent: boolean

      To permanent delete (destroy) the object or not. The destroyed objects will not be able to be recycled.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

deleteWithHttpInfo

  • deleteWithHttpInfo(uuid: string, classname: string, permanent?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Delete the object (row) from the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional permanent: boolean

      To permanent delete (destroy) the object or not. The destroyed objects will not be able to be recycled.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

destroyLangVersion

  • destroyLangVersion(lang: string, version: number, permanent: boolean, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Delete (destroy) the specified \"version\" copy of the given object \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be deleted (ISO-639)

    • version: number

      The object \"version\" number to be deleted.

    • permanent: boolean

      You must explicitly set this header to \"true\" to perform this operation.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

destroyLangVersionWithHttpInfo

  • destroyLangVersionWithHttpInfo(lang: string, version: number, permanent: boolean, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Delete (destroy) the specified \"version\" copy of the given object \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be deleted (ISO-639)

    • version: number

      The object \"version\" number to be deleted.

    • permanent: boolean

      You must explicitly set this header to \"true\" to perform this operation.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

destroyVersion

  • destroyVersion(version: number, permanent: boolean, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Delete (destroy) the specified \"version\" of the given object \"uuid\".

    Parameters

    • version: number

      The object \"version\" number to be deleted.

    • permanent: boolean

      You must explicitly set this header to \"true\" to perform this operation.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

destroyVersionWithHttpInfo

  • destroyVersionWithHttpInfo(version: number, permanent: boolean, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Delete (destroy) the specified \"version\" of the given object \"uuid\".

    Parameters

    • version: number

      The object \"version\" number to be deleted.

    • permanent: boolean

      You must explicitly set this header to \"true\" to perform this operation.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

find

  • find(uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Find the object (row) from the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

findLang

  • findLang(lang: string, uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Find the object (row) from the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

findLangVersion

  • findLangVersion(lang: string, version: number, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Find the specified \"version\" copy of the given object \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to find (ISO-639)

    • version: number

      The object \"version\" number to find.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

findLangVersionWithHttpInfo

  • findLangVersionWithHttpInfo(lang: string, version: number, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Find the specified \"version\" copy of the given object \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to find (ISO-639)

    • version: number

      The object \"version\" number to find.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

findLangWithHttpInfo

  • findLangWithHttpInfo(lang: string, uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Find the object (row) from the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

findVersion

  • findVersion(version: number, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Find the specified \"version\" copy of the given object \"uuid\".

    Parameters

    • version: number

      The object \"version\" number to find.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

findVersionWithHttpInfo

  • findVersionWithHttpInfo(version: number, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Find the specified \"version\" copy of the given object \"uuid\".

    Parameters

    • version: number

      The object \"version\" number to find.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

findWithHttpInfo

  • findWithHttpInfo(uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Find the object (row) from the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

getActions

  • getActions(uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Get current object's available actions.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string
    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

getActionsWithHttpInfo

  • getActionsWithHttpInfo(uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Get current object's available actions.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string
    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

getClassInfo

  • getClassInfo(classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Get persistent class's info.

    Parameters

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

getClassInfoWithHttpInfo

  • getClassInfoWithHttpInfo(classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Get persistent class's info.

    Parameters

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

getLangActions

  • getLangActions(lang: string, uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Get current object's available actions in the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

getLangActionsWithHttpInfo

  • getLangActionsWithHttpInfo(lang: string, uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Get current object's available actions in the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

getLangState

  • getLangState(lang: string, uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Get the current object's state in the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

getLangStateWithHttpInfo

  • getLangStateWithHttpInfo(lang: string, uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Get the current object's state in the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

getLangVersions

  • getLangVersions(lang: string, uuid: string, classname: string, startIndex?: number, endIndex?: number, sortDescending?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • List all object's versions from the given \"uuid\" and the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional endIndex: number

      The query cursor end index (the max rows to be returned will be [\"endIndex\" - \"startIndex\"]).

    • Optional sortDescending: boolean

      To sort the result list using field \"_version\" in descending order (newest first).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

getLangVersionsWithHttpInfo

  • getLangVersionsWithHttpInfo(lang: string, uuid: string, classname: string, startIndex?: number, endIndex?: number, sortDescending?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • List all object's versions from the given \"uuid\" and the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional endIndex: number

      The query cursor end index (the max rows to be returned will be [\"endIndex\" - \"startIndex\"]).

    • Optional sortDescending: boolean

      To sort the result list using field \"_version\" in descending order (newest first).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

getMetadata

  • getMetadata(classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Get persistent class's metadata.

    Parameters

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

getMetadataWithHttpInfo

  • getMetadataWithHttpInfo(classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Get persistent class's metadata.

    Parameters

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

getSchemaInfo

  • getSchemaInfo(classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Get the object's json schema.

    Parameters

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

getSchemaInfoWithHttpInfo

  • getSchemaInfoWithHttpInfo(classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Get the object's json schema.

    Parameters

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

getState

  • getState(uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Get the current object's state.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

getStateWithHttpInfo

  • getStateWithHttpInfo(uuid: string, classname: string, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Get the current object's state.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

getVersions

  • getVersions(uuid: string, classname: string, startIndex?: number, endIndex?: number, sortDescending?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • List all object's versions from the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional endIndex: number

      The query cursor end index (the max rows to be returned will be [\"endIndex\" - \"startIndex\"]).

    • Optional sortDescending: boolean

      To sort the result list using field \"_version\" in descending order (newest first).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

getVersionsWithHttpInfo

  • getVersionsWithHttpInfo(uuid: string, classname: string, startIndex?: number, endIndex?: number, sortDescending?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • List all object's versions from the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional endIndex: number

      The query cursor end index (the max rows to be returned will be [\"endIndex\" - \"startIndex\"]).

    • Optional sortDescending: boolean

      To sort the result list using field \"_version\" in descending order (newest first).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

listClassNames

  • listClassNames(extraHttpRequestParams?: any): Promise<any>

  • List all available persistent classes.

    Parameters

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

listClassNamesWithHttpInfo

  • listClassNamesWithHttpInfo(extraHttpRequestParams?: any): Promise<Response>

  • List all available persistent classes.

    Parameters

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

makeLangStateful

  • makeLangStateful(lang: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Make a stateless object to be stateful with the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

makeLangStatefulActivity

  • makeLangStatefulActivity(lang: string, activityId: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Make a stateless object to be stateful with the given \"uuid\" and \"lang\" starting at the specified \"activityId\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • activityId: string

      The \"activityId\" of object's starting state.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

makeLangStatefulActivityWithHttpInfo

  • makeLangStatefulActivityWithHttpInfo(lang: string, activityId: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Make a stateless object to be stateful with the given \"uuid\" and \"lang\" starting at the specified \"activityId\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • activityId: string

      The \"activityId\" of object's starting state.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

makeLangStatefulWithHttpInfo

  • makeLangStatefulWithHttpInfo(lang: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Make a stateless object to be stateful with the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

makeLangStateless

  • makeLangStateless(lang: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Make a stateful object to be stateless with the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

makeLangStatelessWithHttpInfo

  • makeLangStatelessWithHttpInfo(lang: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Make a stateful object to be stateless with the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

makeStateful

  • makeStateful(uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Make a stateless object to be stateful with the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

makeStateful1

  • makeStateful1(activityId: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Make a stateless object to be stateful with the given \"uuid\" starting at the specified \"activityId\".

    Parameters

    • activityId: string

      The \"activityId\" of object's starting state.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

makeStatefulActivityWithHttpInfo

  • makeStatefulActivityWithHttpInfo(activityId: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Make a stateless object to be stateful with the given \"uuid\" starting at the specified \"activityId\".

    Parameters

    • activityId: string

      The \"activityId\" of object's starting state.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

makeStatefulWithHttpInfo

  • makeStatefulWithHttpInfo(uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Make a stateless object to be stateful with the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

makeStateless

  • makeStateless(uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Make a stateful object to be stateless with the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

makeStatelessWithHttpInfo

  • makeStatelessWithHttpInfo(uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Make a stateful object to be stateless with the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

patchUpdate

  • patchUpdate(uuid: string, classname: string, body?: any, incrementVersion?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Partial update the object (row) on the given \"uuid\". @PATCH operation will only update the fields specified in request data.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be leaved to be the same.

    • Optional incrementVersion: boolean

      Increment the object \"_version\" (if it is version-controlled).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

patchUpdateLang

  • patchUpdateLang(lang: string, uuid: string, classname: string, body?: any, incrementVersion?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Partial update the object (row) on the given \"uuid\" and \"lang\". @PATCH operation will only update the fields specified in request data.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be leaved to be the same.

    • Optional incrementVersion: boolean

      Increment the object \"_version\" (if it is version-controlled).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

patchUpdateLangVersion

  • patchUpdateLangVersion(lang: string, version: number, uuid: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Partial update the specified \"version\" copy of the given object \"uuid\" and \"lang\". @PATCH operation will only update the fields specified in request data.

    Parameters

    • lang: string

      The object's lang code to be updated (ISO-639)

    • version: number

      The object \"version\" number to be updated.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be leaved to be the same.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

patchUpdateLangVersionWithHttpInfo

  • patchUpdateLangVersionWithHttpInfo(lang: string, version: number, uuid: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Partial update the specified \"version\" copy of the given object \"uuid\" and \"lang\". @PATCH operation will only update the fields specified in request data.

    Parameters

    • lang: string

      The object's lang code to be updated (ISO-639)

    • version: number

      The object \"version\" number to be updated.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be leaved to be the same.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

patchUpdateLangWithHttpInfo

  • patchUpdateLangWithHttpInfo(lang: string, uuid: string, classname: string, body?: any, incrementVersion?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Partial update the object (row) on the given \"uuid\" and \"lang\". @PATCH operation will only update the fields specified in request data.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be leaved to be the same.

    • Optional incrementVersion: boolean

      Increment the object \"_version\" (if it is version-controlled).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

patchUpdateVersion

  • patchUpdateVersion(version: number, uuid: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Partial update the specified \"version\" copy of the given object \"uuid\". @PATCH operation will only update the fields specified in request data.

    Parameters

    • version: number

      The object \"version\" number to be updated.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be leaved to be the same.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

patchUpdateVersionWithHttpInfo

  • patchUpdateVersionWithHttpInfo(version: number, uuid: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Partial update the specified \"version\" copy of the given object \"uuid\". @PATCH operation will only update the fields specified in request data.

    Parameters

    • version: number

      The object \"version\" number to be updated.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be leaved to be the same.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

patchUpdateWithHttpInfo

  • patchUpdateWithHttpInfo(uuid: string, classname: string, body?: any, incrementVersion?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Partial update the object (row) on the given \"uuid\". @PATCH operation will only update the fields specified in request data.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be leaved to be the same.

    • Optional incrementVersion: boolean

      Increment the object \"_version\" (if it is version-controlled).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

promoteLangVersion

  • promoteLangVersion(lang: string, version: number, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Promote the specified \"version\" copy of the given object \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • version: number

      The object \"version\" number to be promoted.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

promoteLangVersionWithHttpInfo

  • promoteLangVersionWithHttpInfo(lang: string, version: number, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Promote the specified \"version\" copy of the given object \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • version: number

      The object \"version\" number to be promoted.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

promoteVersion

  • promoteVersion(version: number, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Promote the specified \"version\" copy of the given object \"uuid\".

    Parameters

    • version: number

      The object \"version\" number to be promoted.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

promoteVersionWithHttpInfo

  • promoteVersionWithHttpInfo(version: number, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Promote the specified \"version\" copy of the given object \"uuid\".

    Parameters

    • version: number

      The object \"version\" number to be promoted.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

query

  • query(classname: string, startIndex?: number, count?: number, defaultLangOnly?: boolean, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Query all persistent object without filter.

    Parameters

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional count: number

      The number of max rows will be returned in response result [max=500].

    • Optional defaultLangOnly: boolean

      To query the objects in default lang [_lang=null] only or not.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] objects.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryCount

  • queryCount(classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Count all objects (rows) of this class. This api will count default lang [_lang=null] and in-used [_deleted=false] objects only.

    Parameters

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryCountWithFilter

  • queryCountWithFilter(classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Count the objects (rows) matched by the specified query.

    Parameters

    • classname: string

      The persistent class name.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryCountWithFilterWithHttpInfo

  • queryCountWithFilterWithHttpInfo(classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Count the objects (rows) matched by the specified query.

    Parameters

    • classname: string

      The persistent class name.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryCountWithHttpInfo

  • queryCountWithHttpInfo(classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Count all objects (rows) of this class. This api will count default lang [_lang=null] and in-used [_deleted=false] objects only.

    Parameters

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryDelete

  • queryDelete(classname: string, startIndex?: number, count?: number, defaultLangOnly?: boolean, deleted?: string, permanent?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Delete persistent objects matched by the specified query.

    Parameters

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional count: number

      The number of max rows will be returned in response result [max=500].

    • Optional defaultLangOnly: boolean

      To query the objects in default lang [_lang=null] only or not.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] objects.

    • Optional permanent: boolean

      To permanent delete (destroy) the objects or not. The destroyed objects will not be able to be recycled.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryDeleteWithFilter

  • queryDeleteWithFilter(classname: string, permanent?: boolean, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Delete persistent objects matched by the specified query.

    Parameters

    • classname: string

      The persistent class name.

    • Optional permanent: boolean

      To permanent delete (destroy) the objects or not. The destroyed objects will not be able to be recycled.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryDeleteWithFilterWithHttpInfo

  • queryDeleteWithFilterWithHttpInfo(classname: string, permanent?: boolean, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Delete persistent objects matched by the specified query.

    Parameters

    • classname: string

      The persistent class name.

    • Optional permanent: boolean

      To permanent delete (destroy) the objects or not. The destroyed objects will not be able to be recycled.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryDeleteWithHttpInfo

  • queryDeleteWithHttpInfo(classname: string, startIndex?: number, count?: number, defaultLangOnly?: boolean, deleted?: string, permanent?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Delete persistent objects matched by the specified query.

    Parameters

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional count: number

      The number of max rows will be returned in response result [max=500].

    • Optional defaultLangOnly: boolean

      To query the objects in default lang [_lang=null] only or not.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] objects.

    • Optional permanent: boolean

      To permanent delete (destroy) the objects or not. The destroyed objects will not be able to be recycled.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryLang

  • queryLang(lang: string, classname: string, startIndex?: number, count?: number, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Query all persistent object without filter on the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional count: number

      The number of max rows will be returned in response result [max=500].

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] objects.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryLangCount

  • queryLangCount(lang: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Count all objects (rows) of this class in the specified \"lang\". This api will count in-used [_deleted=false] objects only.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryLangCountWithFilter

  • queryLangCountWithFilter(lang: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Count the objects (rows) matched by the specified query in the given \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryLangCountWithFilterWithHttpInfo

  • queryLangCountWithFilterWithHttpInfo(lang: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Count the objects (rows) matched by the specified query in the given \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryLangCountWithHttpInfo

  • queryLangCountWithHttpInfo(lang: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Count all objects (rows) of this class in the specified \"lang\". This api will count in-used [_deleted=false] objects only.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryLangDelete

  • queryLangDelete(lang: string, classname: string, startIndex?: number, count?: number, deleted?: string, permanent?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Delete persistent objects matched by the specified query.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional count: number

      The number of max rows will be returned in response result [max=500].

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] objects.

    • Optional permanent: boolean

      To permanent delete (destroy) the objects or not. The destroyed objects will not be able to be recycled.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryLangDeleteWithFilter

  • queryLangDeleteWithFilter(lang: string, classname: string, permanent?: boolean, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Delete persistent objects matched by the specified query.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional permanent: boolean

      To permanent delete (destroy) the objects or not. The destroyed objects will not be able to be recycled.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryLangDeleteWithFilterWithHttpInfo

  • queryLangDeleteWithFilterWithHttpInfo(lang: string, classname: string, permanent?: boolean, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Delete persistent objects matched by the specified query.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional permanent: boolean

      To permanent delete (destroy) the objects or not. The destroyed objects will not be able to be recycled.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryLangDeleteWithHttpInfo

  • queryLangDeleteWithHttpInfo(lang: string, classname: string, startIndex?: number, count?: number, deleted?: string, permanent?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Delete persistent objects matched by the specified query.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional count: number

      The number of max rows will be returned in response result [max=500].

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] objects.

    • Optional permanent: boolean

      To permanent delete (destroy) the objects or not. The destroyed objects will not be able to be recycled.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryLangWithFilter

  • queryLangWithFilter(lang: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Query persistent objects with filter on the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryLangWithFilterWithHttpInfo

  • queryLangWithFilterWithHttpInfo(lang: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Query persistent objects with filter on the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryLangWithHttpInfo

  • queryLangWithHttpInfo(lang: string, classname: string, startIndex?: number, count?: number, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Query all persistent object without filter on the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional count: number

      The number of max rows will be returned in response result [max=500].

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] objects.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryWithFilter

  • queryWithFilter(classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Query persistent objects with filter.

    Parameters

    • classname: string

      The persistent class name.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

queryWithFilterWithHttpInfo

  • queryWithFilterWithHttpInfo(classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Query persistent objects with filter.

    Parameters

    • classname: string

      The persistent class name.

    • Optional body: any

      The query filter object.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

queryWithHttpInfo

  • queryWithHttpInfo(classname: string, startIndex?: number, count?: number, defaultLangOnly?: boolean, deleted?: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Query all persistent object without filter.

    Parameters

    • classname: string

      The persistent class name.

    • Optional startIndex: number

      The query cursor start index (or the number of first rows to be skipped).

    • Optional count: number

      The number of max rows will be returned in response result [max=500].

    • Optional defaultLangOnly: boolean

      To query the objects in default lang [_lang=null] only or not.

    • Optional deleted: string

      To query the deleted [true], in-used [false] or both [both|all] objects.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

recycle

  • recycle(uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Recycle the deleted object from the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

recycleLang

  • recycleLang(lang: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Recycle the deleted object from the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

recycleLangWithHttpInfo

  • recycleLangWithHttpInfo(lang: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Recycle the deleted object from the given \"uuid\" and \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

recycleWithHttpInfo

  • recycleWithHttpInfo(uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Recycle the deleted object from the given \"uuid\".

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

refresh

  • refresh(uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Refresh object's state according to process engine.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

refreshLang

  • refreshLang(lang: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Refresh object's state according to process engine in the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

refreshLangWithHttpInfo

  • refreshLangWithHttpInfo(lang: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Refresh object's state according to process engine in the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

refreshWithHttpInfo

  • refreshWithHttpInfo(uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Refresh object's state according to process engine.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

trigger

  • trigger(action: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Trigger the object state change with the given \"action\".

    Parameters

    • action: string

      The object's \"action\" to be triggerred.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

triggerLang

  • triggerLang(lang: string, action: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Trigger the object state change with the given \"action\" in the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • action: string

      The object's \"action\" to be triggerred.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

triggerLangWithHttpInfo

  • triggerLangWithHttpInfo(lang: string, action: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Trigger the object state change with the given \"action\" in the specified \"lang\".

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • action: string

      The object's \"action\" to be triggerred.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

triggerWithHttpInfo

  • triggerWithHttpInfo(action: string, uuid: string, classname: string, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Trigger the object state change with the given \"action\".

    Parameters

    • action: string

      The object's \"action\" to be triggerred.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

update

  • update(uuid: string, classname: string, body?: any, incrementVersion?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Update the object (row) on the given \"uuid\". @PUT method will replace all field values in persistent object. If you want to perform partial-update, please see @PATCH operation for more info.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be set to \"null\" value.

    • Optional incrementVersion: boolean

      Increment the object \"_version\" (if it is version-controlled).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

updateLang

  • updateLang(lang: string, uuid: string, classname: string, body?: any, incrementVersion?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Update the object (row) on the given \"uuid\" and \"lang\". @PUT method will replace all field values in persistent object. If you want to perform partial-update, please see @PATCH operation for more info.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be set to \"null\" value.

    • Optional incrementVersion: boolean

      Increment the object \"_version\" (if it is version-controlled).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

updateLangVersion

  • updateLangVersion(lang: string, version: number, uuid: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Update the specified \"version\" copy of the given object \"uuid\" and \"lang\". @PUT method will replace all field values in persistent object. If you want to perform partial-update, please see @PATCH operation for more info.

    Parameters

    • lang: string

      The object's lang code to be updated (ISO-639)

    • version: number

      The object \"version\" number to be updated.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be set to \"null\" value.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

updateLangVersionWithHttpInfo

  • updateLangVersionWithHttpInfo(lang: string, version: number, uuid: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Update the specified \"version\" copy of the given object \"uuid\" and \"lang\". @PUT method will replace all field values in persistent object. If you want to perform partial-update, please see @PATCH operation for more info.

    Parameters

    • lang: string

      The object's lang code to be updated (ISO-639)

    • version: number

      The object \"version\" number to be updated.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be set to \"null\" value.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

updateLangWithHttpInfo

  • updateLangWithHttpInfo(lang: string, uuid: string, classname: string, body?: any, incrementVersion?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Update the object (row) on the given \"uuid\" and \"lang\". @PUT method will replace all field values in persistent object. If you want to perform partial-update, please see @PATCH operation for more info.

    Parameters

    • lang: string

      The object's lang code to be queried (ISO-639)

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be set to \"null\" value.

    • Optional incrementVersion: boolean

      Increment the object \"_version\" (if it is version-controlled).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

updateVersion

  • updateVersion(version: number, uuid: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<any>

  • Update the specified \"version\" copy of the given object \"uuid\". @PUT method will replace all field values in persistent object. If you want to perform partial-update, please see @PATCH operation for more info

    Parameters

    • version: number

      The object \"version\" number to be updated.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be set to \"null\" value.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<any>

updateVersionWithHttpInfo

  • updateVersionWithHttpInfo(version: number, uuid: string, classname: string, body?: any, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Update the specified \"version\" copy of the given object \"uuid\". @PUT method will replace all field values in persistent object. If you want to perform partial-update, please see @PATCH operation for more info

    Parameters

    • version: number

      The object \"version\" number to be updated.

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be set to \"null\" value.

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

updateWithHttpInfo

  • updateWithHttpInfo(uuid: string, classname: string, body?: any, incrementVersion?: boolean, langPreference?: string, extraHttpRequestParams?: any): Promise<Response>

  • Update the object (row) on the given \"uuid\". @PUT method will replace all field values in persistent object. If you want to perform partial-update, please see @PATCH operation for more info.

    Parameters

    • uuid: string

      The persistent object (row) \"uuid\".

    • classname: string

      The persistent class name.

    • Optional body: any

      The object fields to be updated. All object fields not presented in this request data will be set to \"null\" value.

    • Optional incrementVersion: boolean

      Increment the object \"_version\" (if it is version-controlled).

    • Optional langPreference: string

      The language preference used to perform the operation (especially in READ operations such as find/query).

    • Optional extraHttpRequestParams: any

    Returns Promise<Response>

Generated using TypeDoc