Type Alias Glossary

type Glossary = {
    createGlossarySchema(
        glossarySchemaData: GlossarySchemaItemSkeleton<any>,
    ): Promise<GlossarySchemaItemSkeleton<any>>;
    deleteGlossarySchema(
        glossaryId: string,
    ): Promise<GlossarySchemaItemSkeleton<any>>;
    deleteGlossarySchemaByNameAndObjectType(
        glossaryName: string,
        objectType: GlossaryObjectType,
    ): Promise<GlossarySchemaItemSkeleton<any>>;
    deleteGlossarySchemas(
        resultCallback?: ResultCallback<GlossarySchemaItemSkeleton<any>>,
    ): Promise<GlossarySchemaItemSkeleton<any>[]>;
    exportGlossarySchema(
        glossaryId: string,
    ): Promise<GlossarySchemaExportInterface>;
    exportGlossarySchemaByNameAndObjectType(
        glossaryName: string,
        objectType: GlossaryObjectType,
    ): Promise<GlossarySchemaExportInterface>;
    exportGlossarySchemas(
        options?: GlossarySchemaExportOptions,
    ): Promise<GlossarySchemaExportInterface>;
    importGlossarySchemas(
        importData: GlossarySchemaExportInterface,
        glossaryId?: string,
        glossaryName?: string,
        objectType?: GlossaryObjectType,
        options?: GlossarySchemaImportOptions,
        resultCallback?: ResultCallback<GlossarySchemaItemSkeleton<any>>,
    ): Promise<GlossarySchemaItemSkeleton<any>[]>;
    readGlossarySchema(
        glossaryId: string,
    ): Promise<GlossarySchemaItemSkeleton<any>>;
    readGlossarySchemaByNameAndObjectType(
        glossaryName: string,
        objectType: GlossaryObjectType,
    ): Promise<GlossarySchemaItemSkeleton<any>>;
    readGlossarySchemas(): Promise<GlossarySchemaItemSkeleton<any>[]>;
    updateGlossarySchema(
        glossaryId: string,
        glossarySchemaData: GlossarySchemaItemSkeleton<any>,
    ): Promise<GlossarySchemaItemSkeleton<any>>;
}

Index

Methods

createGlossarySchema deleteGlossarySchema deleteGlossarySchemaByNameAndObjectType deleteGlossarySchemas exportGlossarySchema exportGlossarySchemaByNameAndObjectType exportGlossarySchemas importGlossarySchemas readGlossarySchema readGlossarySchemaByNameAndObjectType readGlossarySchemas updateGlossarySchema

Methods

createGlossarySchema

createGlossarySchema(
glossarySchemaData: GlossarySchemaItemSkeleton<any>,
): Promise<GlossarySchemaItemSkeleton<any>>
Create glossary schema
Parameters
- glossarySchemaData: GlossarySchemaItemSkeleton<any>
  the glossary schema object
Returns Promise<GlossarySchemaItemSkeleton<any>>
a promise that resolves to a glossary schema object
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:27

deleteGlossarySchema

deleteGlossarySchema(
glossaryId: string,
): Promise<GlossarySchemaItemSkeleton<any>>
Delete glossary schema
Parameters
- glossaryId: string
  the glossary schema id
Returns Promise<GlossarySchemaItemSkeleton<any>>
a promise that resolves to a glossary schema object
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:112

deleteGlossarySchemaByNameAndObjectType

deleteGlossarySchemaByNameAndObjectType(
glossaryName: string,
objectType: GlossaryObjectType,
): Promise<GlossarySchemaItemSkeleton<any>>
Delete glossary schema by its name and object type
Parameters
- glossaryName: string
  the glossary schema name
- objectType: GlossaryObjectType
  the glossary schema object type
Returns Promise<GlossarySchemaItemSkeleton<any>>
a promise that resolves to a glossary schema object
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:121

deleteGlossarySchemas

deleteGlossarySchemas(
resultCallback?: ResultCallback<GlossarySchemaItemSkeleton<any>>,
): Promise<GlossarySchemaItemSkeleton<any>[]>
Delete glossary schemas
Parameters
- OptionalresultCallback: ResultCallback<GlossarySchemaItemSkeleton<any>>
  Optional callback to process individual results
Returns Promise<GlossarySchemaItemSkeleton<any>[]>
promise that resolves to an array of glossary schema objects
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:130

exportGlossarySchema

exportGlossarySchema(glossaryId: string): Promise<GlossarySchemaExportInterface>
Export glossary schema
Parameters
- glossaryId: string
  the glossary schema id
Returns Promise<GlossarySchemaExportInterface>
a promise that resolves to a glossary schema export object
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:58

exportGlossarySchemaByNameAndObjectType

exportGlossarySchemaByNameAndObjectType(
glossaryName: string,
objectType: GlossaryObjectType,
): Promise<GlossarySchemaExportInterface>
Export glossary schema by its name and object type
Parameters
- glossaryName: string
  the glossary schema name
- objectType: GlossaryObjectType
  the glossary schema object type
Returns Promise<GlossarySchemaExportInterface>
a promise that resolves to a glossary schema export object
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:67

exportGlossarySchemas

exportGlossarySchemas(
options?: GlossarySchemaExportOptions,
): Promise<GlossarySchemaExportInterface>
Export all glossary schemas
Parameters
- Optionaloptions: GlossarySchemaExportOptions
  export options
Returns Promise<GlossarySchemaExportInterface>
a promise that resolves to a glossary schema export object
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:76

importGlossarySchemas

importGlossarySchemas(
    importData: GlossarySchemaExportInterface,
    glossaryId?: string,
    glossaryName?: string,
    objectType?: GlossaryObjectType,
    options?: GlossarySchemaImportOptions,
    resultCallback?: ResultCallback<GlossarySchemaItemSkeleton<any>>,
): Promise<GlossarySchemaItemSkeleton<any>[]>
Import glossary schemas
Parameters
- importData: GlossarySchemaExportInterface
  glossary schema import data
- OptionalglossaryId: string
  The glossary schema id. If supplied, only the glossary schema of that id is imported. Takes priority over glossaryName/objectType if they are all provided.
- OptionalglossaryName: string
  The glossary schema name. If supplied along with the objectType, only the glossary schema of that name/objectType is imported.
- OptionalobjectType: GlossaryObjectType
  the glossary schema object type
- Optionaloptions: GlossarySchemaImportOptions
  import options
- OptionalresultCallback: ResultCallback<GlossarySchemaItemSkeleton<any>>
  Optional callback to process individual results
Returns Promise<GlossarySchemaItemSkeleton<any>[]>
the imported glossary schemas
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:99

readGlossarySchema

readGlossarySchema(glossaryId: string): Promise<GlossarySchemaItemSkeleton<any>>
Read glossary schema
Parameters
- glossaryId: string
  the glossary schema id
Returns Promise<GlossarySchemaItemSkeleton<any>>
a promise that resolves to a glossary schema object
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:35

readGlossarySchemaByNameAndObjectType

readGlossarySchemaByNameAndObjectType(
glossaryName: string,
objectType: GlossaryObjectType,
): Promise<GlossarySchemaItemSkeleton<any>>
Read glossary schema by its name and object type
Parameters
- glossaryName: string
  the glossary schema name
- objectType: GlossaryObjectType
  the glossary schema object type
Returns Promise<GlossarySchemaItemSkeleton<any>>
a promise that resolves to a glossary schema object
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:44

readGlossarySchemas

readGlossarySchemas(): Promise<GlossarySchemaItemSkeleton<any>[]>
Read all glossary schemas

Returns Promise<GlossarySchemaItemSkeleton<any>[]>
a promise that resolves to an array of glossary schema objects
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:52

updateGlossarySchema

updateGlossarySchema(
glossaryId: string,
glossarySchemaData: GlossarySchemaItemSkeleton<any>,
): Promise<GlossarySchemaItemSkeleton<any>>
Update glossary schema
Parameters
- glossaryId: string
  the glossary schema id
- glossarySchemaData: GlossarySchemaItemSkeleton<any>
  the glossary schema object
Returns Promise<GlossarySchemaItemSkeleton<any>>
a promise that resolves to a glossary schema object
- Defined in ops/cloud/iga/IgaGlossaryOps.ts:85

Type Alias Glossary

Index

Methods

Methods

createGlossarySchema

Parameters

Returns Promise<GlossarySchemaItemSkeleton<any>>

deleteGlossarySchema

Parameters

Returns Promise<GlossarySchemaItemSkeleton<any>>

deleteGlossarySchemaByNameAndObjectType

Parameters

Returns Promise<GlossarySchemaItemSkeleton<any>>

deleteGlossarySchemas

Parameters

Returns Promise<GlossarySchemaItemSkeleton<any>[]>

exportGlossarySchema

Parameters

Returns Promise<GlossarySchemaExportInterface>

exportGlossarySchemaByNameAndObjectType

Parameters

Returns Promise<GlossarySchemaExportInterface>

exportGlossarySchemas

Parameters

Returns Promise<GlossarySchemaExportInterface>

importGlossarySchemas

Parameters

Returns Promise<GlossarySchemaItemSkeleton<any>[]>

readGlossarySchema

Parameters

Returns Promise<GlossarySchemaItemSkeleton<any>>

readGlossarySchemaByNameAndObjectType

Parameters

Returns Promise<GlossarySchemaItemSkeleton<any>>

readGlossarySchemas

Returns Promise<GlossarySchemaItemSkeleton<any>[]>

updateGlossarySchema

Parameters

Returns Promise<GlossarySchemaItemSkeleton<any>>

Settings

On This Page