diff --git a/api-spec.json b/api-spec.json index 9f455174..2dd2f103 100644 --- a/api-spec.json +++ b/api-spec.json @@ -126,6 +126,20 @@ } } }, + "AppScriptMeta": { + "x-qlik-stability": "experimental", + "type": "struct", + "entries": { + "IsLocked": { + "description": "True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS.", + "type": "bool" + }, + "Meta": { + "description": "Information about publishing and permissions.\nThis parameter is optional.", + "type": "#/definitions/NxMeta" + } + } + }, "ArrayOfNxValuePoint": { "type": "slice", "items": { @@ -467,6 +481,10 @@ "BookmarkVariableItem": { "type": "struct", "entries": { + "Definition": { + "description": "The Reporting mode definition of the variable.", + "type": "string" + }, "Name": { "description": "Name of the variable.", "type": "string" @@ -4442,6 +4460,42 @@ } ] }, + "GetScriptMeta": { + "description": "Gets script meta-data.", + "x-qlik-stability": "experimental", + "type": "method", + "params": [ + { + "type": "https://golang.org/pkg/context/Context" + } + ], + "returns": [ + { + "type": "#/definitions/AppScriptMeta" + }, + { + "type": "error" + } + ] + }, + "GetScriptMetaRaw": { + "description": "Gets script meta-data.", + "x-qlik-stability": "experimental", + "type": "method", + "params": [ + { + "type": "https://golang.org/pkg/context/Context" + } + ], + "returns": [ + { + "type": "https://golang.org/pkg/encoding/json/RawMessage" + }, + { + "type": "error" + } + ] + }, "GetSetAnalysis": { "description": "Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.\n | | BookmarkId empty | BookmarkId set |\n |-----------------------|--------------------------------------|----------------------------------------------------|\n |StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |\n |StateName set | State selections is returned. | State in bookmark with id is returned. |\n\nParameters:\n\n◾ stateName - Optional. The name of the state to get set analysis expression for. If left empty, the default state will be retrieved.\n\n◾ bookmarkId - Optional. The Id of the bookmark to get the set analysis expression for. If left empty, the current selection will be retrieved.", "x-qlik-stability": "locked", diff --git a/qix_generated.go b/qix_generated.go index 9275c038..3de2cbdb 100644 --- a/qix_generated.go +++ b/qix_generated.go @@ -1,4 +1,4 @@ -// Code generated by QIX generator (./schema/generate.go) for Qlik Associative Engine version 12.1561.0 . DO NOT EDIT. +// Code generated by QIX generator (./schema/generate.go) for Qlik Associative Engine version 12.1595.0 . DO NOT EDIT. package enigma @@ -8,7 +8,7 @@ import ( ) // Version of the schema used to generate the enigma.go QIX API -const QIX_SCHEMA_VERSION = "12.1561.0" +const QIX_SCHEMA_VERSION = "12.1595.0" // Deprecated: This will be removed in a future version type AlfaNumString struct { @@ -73,6 +73,15 @@ type AppScript struct { IsLocked bool `json:"qIsLocked,omitempty"` } +// Stability: experimental +type AppScriptMeta struct { + // Information about publishing and permissions. + // This parameter is optional. + Meta *NxMeta `json:"qMeta,omitempty"` + // True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS. + IsLocked bool `json:"qIsLocked,omitempty"` +} + type ArrayOfNxValuePoint []*NxPivotValuePoint type AssociationScore struct { @@ -349,6 +358,8 @@ type BookmarkVariableItem struct { Name string `json:"qName,omitempty"` // Value of the variable. Value *FieldValue `json:"qValue,omitempty"` + // The Reporting mode definition of the variable. + Definition string `json:"qDefinition,omitempty"` } type CalendarStrings struct { @@ -8844,6 +8855,26 @@ func (obj *Doc) GetScriptExRaw(ctx context.Context) (json.RawMessage, error) { return result.Script, err } +// Gets script meta-data. +// Stability: experimental +func (obj *Doc) GetScriptMeta(ctx context.Context) (*AppScriptMeta, error) { + result := &struct { + Meta *AppScriptMeta `json:"qMeta"` + }{} + err := obj.RPC(ctx, "GetScriptMeta", result) + return result.Meta, err +} + +// Gets script meta-data. +// Stability: experimental +func (obj *Doc) GetScriptMetaRaw(ctx context.Context) (json.RawMessage, error) { + result := &struct { + Meta json.RawMessage `json:"qMeta"` + }{} + err := obj.RPC(ctx, "GetScriptMeta", result) + return result.Meta, err +} + // Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression. // | | BookmarkId empty | BookmarkId set | // |-----------------------|--------------------------------------|----------------------------------------------------| diff --git a/schema/engine-rpc.json b/schema/engine-rpc.json index a83594ae..8d23fd99 100644 --- a/schema/engine-rpc.json +++ b/schema/engine-rpc.json @@ -2,7 +2,7 @@ "openrpc": "1.0.0", "info": { "title": "QIX", - "version": "12.1561.0", + "version": "12.1595.0", "description": "The JSON-RPC API over websocket that enables you to interact with the Qlik Associative Engine." }, "methods": [ @@ -9444,6 +9444,32 @@ ], "x-qlik-stability": "experimental" }, + { + "name": "Doc.GetScriptMeta", + "description": "Gets script meta-data.", + "params": [], + "result": { + "name": "Results for Doc.GetScriptMeta", + "schema": { + "type": "object", + "properties": { + "qMeta": { + "type": "object", + "$ref": "#/components/schemas/AppScriptMeta" + } + } + } + }, + "errors": [ + { + "$ref": "#/components/errors/GenericErrors" + } + ], + "x-qlik-stability": "experimental", + "x-qlik-access-control": [ + "read" + ] + }, { "name": "Doc.CommitScript", "description": "Commits the current script version so that any future changes will be part of a new version.", @@ -14404,6 +14430,10 @@ "type": "object", "description": "Value of the variable.", "$ref": "#/components/schemas/FieldValue" + }, + "qDefinition": { + "type": "string", + "description": "The Reporting mode definition of the variable." } } }, @@ -21150,6 +21180,21 @@ }, "x-qlik-stability": "experimental" }, + "AppScriptMeta": { + "type": "object", + "properties": { + "qMeta": { + "type": "object", + "description": "Information about publishing and permissions.\nThis parameter is optional.", + "$ref": "#/components/schemas/NxMeta" + }, + "qIsLocked": { + "type": "boolean", + "description": "True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS." + } + }, + "x-qlik-stability": "experimental" + }, "ProgressData": { "type": "object", "properties": {