--- openapi: "3.0.1" info: title: "hxgn-api-dialog" description: "The Hexagon Dialog API is a web service useful in orchestrating rich\ \ enterprise applications. User interfaces are defined abstractly in a back-end\ \ service using metadata techniques. The dialog API \"directs\" the user interface\ \ by serving up abstract user interfaces as mixtures of domain-data and metadata.\ \ User interface actions, such as menu actions, are resolved dynamically in the\ \ dialog service resulting in workflow navigation. This technique of interacting\ \ with the server is called \"dialoging\", as in \"a conversation\", and the API\ \ objects employed for this conversation are called \"dialog\" objects. The effect\ \ of this architecture is a device-independent user interface service with intrinsic\ \ workflow capabilities useful for creating rich and adaptive enterprise applications.\n" termsOfService: "https://dialog.hxgn-api.net/terms" contact: name: "Hexagon Dialog API Support" url: "https://dialog.hxgn-api.net/support" email: "support@hxgn-api.net" license: name: "Hexagon Dialog API License" url: "https://dialog.hxgn-api.net/license" version: "1.0.63" servers: - url: "https://dialog.hxgn-api.net" paths: /v0/tenants/{tenantId}/clientType/{clientType}: get: tags: - "tenant" summary: "Retreive the capabilities and branding details for {tenantId}. This\ \ call is to be made\n BEFORE login to assess the capabilities of the selected\ \ tenant." description: "Retreive the capabilities and branding details for {tenantId}.\ \ This call is to be made\n BEFORE login to assess the capabilities of the\ \ selected tenant." operationId: "onGetTenantCapabilities" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "clientType" in: "path" description: "The well-known clientType passed from client to server" required: true schema: type: "string" responses: 200: description: "The capabilities and branding details for {tenantId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.TenantCapabilities" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/oauth/{authrizationInfo}: get: tags: - "oAuth" summary: "The initial authorize API for OAuth Login ." description: "The initial authorize API for OAuth Login ." operationId: "onPostOAuthAutherize" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "authrizationInfo" in: "path" description: "The authrization information passed from client to server" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.OAuthParameters" responses: 200: description: "OAUTH Login URL information to indicate this is a special\ \ OAUTH login redirection" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Redirection" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/oauth/{callbackInfo}: get: tags: - "oauth" summary: "Callback API." description: "Callback API." operationId: "onGetOAuthCallback" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "callbackInfo" in: "path" description: "The callbackInfo information passed from client to server" required: true schema: type: "string" responses: 200: description: "HTTP redirect status code and location header" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.BrowserRedirection" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions: post: tags: - "session" summary: "Create a new session for the given {tenantId} and {login}" description: "Create a new session for the given {tenantId} and {login}" operationId: "onPostSession" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "clientIPAddress" in: "path" description: "The current user ip address" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Login" responses: 200: description: "Session created for the given {tenantId} and {login}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Session" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" 401: description: "Unauthorized" 303: description: "Redirect to a new dialog. Multi-factor authentication is the\ \ most likely scenario to cause a redirection." content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Redirection" /v0/tenants/{tenantId}/sessions/{sessionId}: get: tags: - "session" summary: "Return the session OBJECT at {tenantId} and {sessionId}" description: "Return the session OBJECT at {tenantId} and {sessionId}" operationId: "onGetSession" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" responses: 200: description: "Session OBJECT at {sessionId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SessionId" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" delete: tags: - "session" summary: "Delete the session at {tenantId} and {sessionId}" description: "Delete the session at {tenantId} and {sessionId}" operationId: "onDeleteSession" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" responses: 200: description: "Session deleted at {tenantId} and {sessionId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SessionId" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/actions/{actionId}: post: tags: - "session" summary: "Take the Session Offline with {sessionHandle}" description: "Take the Session Offline with {sessionHandle}" operationId: "onPerformSessionAction" parameters: - name: "tenantId" in: "path" description: " The tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "actionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" responses: 200: description: "Returns whether the client should crawl" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Session" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/callbackRequest/{token}: post: tags: - "" summary: "A server-side user interface component identified by {dialogId}. A\ \ dialog resource\n contains both domain-data and meta-data. When combined,\ \ busness-data and meta-data\n constitute an actionable user interface component." description: "A server-side user interface component identified by {dialogId}.\ \ A dialog resource\n contains both domain-data and meta-data. When combined,\ \ busness-data and meta-data\n constitute an actionable user interface component." operationId: "onPostOAuthSession" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "token" in: "path" description: " The full path URL from the call" required: true schema: type: "string" responses: 200: description: "Redirection" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Redirection" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/changePassword: post: tags: - "session" summary: "Change the password after login is success, if password expiry is\ \ nearing" description: "Change the password after login is success, if password expiry\ \ is nearing" operationId: "onChangePassword" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.PasswordFields" responses: 200: description: "sessionId at {SessionIdModel}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.PasswordFields" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/designLink/{deepLink}: get: tags: - "" summary: "Performs DeepLink" description: "Performs DeepLink" operationId: "performDeepLink" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "deepLinkId" in: "path" description: "The identifier of a deepLink" required: true schema: type: "string" responses: 200: description: "Returns Redirection for DeepLink" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Redirection" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}: get: tags: - "dialog" summary: "A server-side user interface component identified by {dialogId}. A\ \ dialog resource\n contains both domain-data and meta-data. When combined,\ \ busness-data and meta-data\n constitute an actionable user interface component." description: "A server-side user interface component identified by {dialogId}.\ \ A dialog resource\n contains both domain-data and meta-data. When combined,\ \ busness-data and meta-data\n constitute an actionable user interface component." operationId: "onGetDialog" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "Dialog at {dialogId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Dialog" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" delete: tags: - "dialog" summary: "Delete the dialog at {dialogId}" description: "Delete the dialog at {dialogId}" operationId: "onDeleteDialog" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "Dialog deleted at {dialogId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogId" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/actions: get: tags: - "action" summary: "==>NOT IMPLEMENTED<== Return the list of dialog actions at {dialogId}" description: "==>NOT IMPLEMENTED<== Return the list of dialog actions at {dialogId}" operationId: "onGetDialogActions" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "The list of dialog actions at {dialogId}" content: application/json: schema: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Menu" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/actions/{actionId}: post: tags: - "action" summary: "Perform the dialog action at {actionId}" description: "Perform the dialog action at {actionId}" operationId: "onPostMenuAction" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" - name: "actionId" in: "path" description: " The identifier of a server-side action" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ActionParameters" responses: 200: description: "Dialog action at {actionId} completed successfully" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Redirection" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/avaliableViews: get: tags: - "view" summary: "Return a list of available views at {dialogId}" description: "Return a list of available views at {dialogId}" operationId: "onGetAvailableViews" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "List of available views at {dialogId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ViewDescriptor" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/columnStatistics: get: tags: - "dialog" summary: "Perform the calculate column statistics" description: "Perform the calculate column statistics" operationId: "onGetColumnStatistics" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "Column Statistic result" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.RecordSet" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/record: get: tags: - "record" summary: "Return record at editor {dialogId}" description: "Return record at editor {dialogId}" operationId: "onGetRecord" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "Record at editor {dialogId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ViewDescriptor" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" put: tags: - "record" summary: "Put a new record at editor dialog {dialogId}. Whether or not a record\ \ is copied, created,\n deleted or updated depends on the dialog mode of the\ \ editor at {dialogId}." description: "Put a new record at editor dialog {dialogId}. Whether or not a\ \ record is copied, created,\n deleted or updated depends on the dialog mode\ \ of the editor at {dialogId}." operationId: "onPutRecord" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Record" responses: 200: description: "Record put at editor {dialogId}tenants{tenantId}sessions{sessionId}dialogs{\n\ \ dialogId}record{propertyName}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Record" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/record/{propertyName}: get: tags: - "record" summary: "==>NOT IMPLEMENTED<== Download the setContent from {dialogId}record{propertyName}" description: "==>NOT IMPLEMENTED<== Download the setContent from {dialogId}record{propertyName}" operationId: "onGetRecordProperty" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" - name: "propertyName" in: "path" description: "The name of the property for this operation" required: true schema: type: "string" responses: 200: description: "Content from {dialogId}record{propertyName}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Property" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" put: tags: - "record" summary: "Put a Base64 encoded chunk of data to {dialogId}record{propertyName}" description: "Put a Base64 encoded chunk of data to {dialogId}record{propertyName}" operationId: "onPutRecordLargeProperty" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for\ \ a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user\ \ session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user\ \ interface\n component" required: true schema: type: "string" - name: "propertyName" in: "path" description: " The name of the property for this operation" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.WriteLargePropertyParameters" responses: 200: description: "Put Base64 encoded chunk of data completed successfully" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.PropertyName" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" post: tags: - "record" summary: "Fetch a Base64 encoded chunk of data from and editor dialog {dialogId}record{propertyName}" description: "Fetch a Base64 encoded chunk of data from and editor dialog {dialogId}record{propertyName}" operationId: "onPostRecordLargeProperty" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for\ \ a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user\ \ session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user\ \ interface\n component" required: true schema: type: "string" - name: "propertyName" in: "path" description: " The name of the property for this operation" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ReadLargePropertyParameters" responses: 200: description: "A Base64 encoded chunk of data from {dialogId}record{propertyName}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.LargeProperty" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/record/{propertyName}/availableValues: post: tags: - "record" summary: "Return the available values for {propertyName}" description: "Return the available values for {propertyName}" operationId: "onPostAvailableValues" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a\ \ tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface\n\ \ component" required: true schema: type: "string" - name: "propertyName" in: "path" description: " The name of the property for this operation" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.AvailableValuesParameters" responses: 200: description: "Available values for property {propertyName}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.AvailableValuesParameters" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/record/{propertyName}/sideEffects: post: tags: - "record" summary: "Return the side effects for a proposed change to {propertyName}" description: "Return the side effects for a proposed change to {propertyName}" operationId: "onPostSideEffects" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface\ \ component" required: true schema: type: "string" - name: "propertyName" in: "path" description: " The name of the property for this operation" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SideEffectsParameters" responses: 200: description: "Side effects for a proposed change to {propertyName}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SideEffectsParameters" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/records: put: tags: - "record" summary: "Perform multiple record update" description: "Perform multiple record update" operationId: "processQueryWrite" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface\ \ component" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.QueryActionParameters" responses: 200: description: "completed successfully message" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Redirection" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" post: tags: - "record" summary: "Return the list of records at query {dialogId} restricted by {fetchDirection}\ \ and {\n fetchMaxRecords}" description: "Return the list of records at query {dialogId} restricted by {fetchDirection}\ \ and {\n fetchMaxRecords}" operationId: "onPostRecords" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.QueryParameters" responses: 200: description: "List of records at query {dialogId} restricted by {fetchDirection}\ \ and {\n fetchMaxRecords}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.RecordSet" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/records/{propertyName}: post: tags: - "record" summary: "Fetch a Base64 encoded chunk of data from a list dialog {dialogId}records{propertyName}" description: "Fetch a Base64 encoded chunk of data from a list dialog {dialogId}records{propertyName}" operationId: "onPostRecordsProperty" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for\ \ a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user\ \ session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user\ \ interface\n component" required: true schema: type: "string" - name: "propertyName" in: "path" description: " The name of the property for this operation" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ReadLargePropertyParameters" responses: 200: description: "A Base64 encoded chunk of data from {dialogId}records{propertyName}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.LargeProperty" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/selectedView: get: tags: - "view" - "dialog" summary: "==>NOT IMPLEMENTED<== Return the viewId of the currently selected\ \ view" description: "==>NOT IMPLEMENTED<== Return the viewId of the currently selected\ \ view" operationId: "onGetSelectedView" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "The viewId of the currently selected view" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ViewDescriptor" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/selectedView/{viewId}: put: tags: - "view" - "dialog" summary: "" description: "" operationId: "onPutSelectedView" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" - name: "viewId" in: "path" description: " The viewId of the new view" required: true schema: type: "string" responses: 200: description: "View changed at dialog {dialogId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Dialog" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/upload: post: tags: - "" summary: "Post a multipart encoded chunk of data to {dialogId}record{propertyName}" description: "Post a multipart encoded chunk of data to {dialogId}record{propertyName}" operationId: "onPutAttachment" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" - name: "content" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "Put multipart data completed successfully" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Dialog" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/view: get: tags: - "view" summary: "Return the view at {dialogId}" description: "Return the view at {dialogId}" operationId: "onGetView" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "View at {dialogId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.View" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/viewMode: get: tags: - "view" summary: "Return the view mode at {dialogId}. Although queries and editors have\ \ view modes, only\n editor's can have their view mode changed to write." description: "Return the view mode at {dialogId}. Although queries and editors\ \ have view modes, only\n editor's can have their view mode changed to write." operationId: "onGetViewMode" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" responses: 200: description: "The view mode at {dialogId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ViewMode" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/dialogs/{dialogId}/viewMode/{viewMode}: put: tags: - "view" summary: "Change view mode at editor {dialogId}" description: "Change view mode at editor {dialogId}" operationId: "onPutViewMode" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "dialogId" in: "path" description: " The identifier of a server-side user interface component" required: true schema: type: "string" - name: "viewMode" in: "path" description: " The new view mode at {dialogId}" required: true schema: type: "string" responses: 200: description: "View mode changed at editor {dialogId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.EditorDialog" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/documents/viewPersistentId/getSalt: post: tags: - "" summary: "Fetch salt document" description: "Fetch salt document" operationId: "onGetSaltDocument" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "viewPersistentId" in: "path" description: " The persistent identifier for a dialog" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SaltParameters" responses: 200: description: "Returns salt document in json format" content: application/json: schema: $ref: "#/components/schemas/hxgn.util.JSONObject" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/documents/viewPersistentId/getSaltNames: post: tags: - "" summary: "Fetch salt document names" description: "Fetch salt document names" operationId: "onGetSaltDocumentNames" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "viewPersistentId" in: "path" description: " The persistent identifier for a dialog" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SaltParameters" responses: 200: description: "Returns salt document names" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ArrayResult" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/documents/{viewPersistentId}/createSalt: post: tags: - "" summary: "Create salt document names" description: "Create salt document names" operationId: "onCreateSaltDocument" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "viewPersistentId" in: "path" description: " The persistent identifier for a dialog" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SaltParameters" responses: 200: description: "Salt Document created successfully" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/documents/{viewPersistentId}/deleteSalt: post: tags: - "" summary: "Delete salt document names" description: "Delete salt document names" operationId: "onDeleteSaltDocument" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "viewPersistentId" in: "path" description: " The persistent identifier for a dialog" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SaltParameters" responses: 200: description: "Salt Document deleted successfully" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/documents/{viewPersistentId}/getEffectiveSalt: post: tags: - "" summary: "Fetch salt document" description: "Fetch salt document" operationId: "onGetEffectiveSaltDocument" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "viewPersistentId" in: "path" description: " The persistent identifier for a dialog" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SaltParameters" responses: 200: description: "Returns salt document in json format" content: application/json: schema: $ref: "#/components/schemas/hxgn.util.JSONObject" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/documents/{viewPersistentId}/updateSalt: put: tags: - "" summary: "Update salt document names" description: "Update salt document names" operationId: "onUpdateSaltDocument" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "viewPersistentId" in: "path" description: " The persistent identifier for a dialog" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SaltParameters" responses: 200: description: "Salt Document updated successfully" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/getSaltImageNames: post: tags: - "" summary: "Fetch Image names" description: "Fetch Image names" operationId: "onGetSaltImageNames" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SaltParameters" responses: 200: description: "Returns Image names" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ArrayResult" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/redirections/{redirectionId}: get: tags: - "redirection" summary: "Return the redirection at {tenantId}, {sessionId}, and {redirectionId}" description: "Return the redirection at {tenantId}, {sessionId}, and {redirectionId}" operationId: "onGetRedirection" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "redirectionId" in: "path" description: "The identifier of a redirection" required: true schema: type: "string" responses: 200: description: "Redirection at {tenantId}, {sessionId}, and {redirectionId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Redirection" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/sampleData/{persistentId}: post: tags: - "" summary: "Gives sample data response" description: "Gives sample data response" operationId: "getSampleData" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "persistentId" in: "path" description: " The identifier of view persistentId" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.configuration.DesignParameters" responses: 200: description: "Returns sample data response" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.EditorSampleData" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/sessionCount: get: tags: - "session" summary: "Return the session count" description: "Return the session count" operationId: "onGetSessionCount" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" responses: 200: description: "Session Count for the {sessionId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SessionCount" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/setContent/{contentId}: get: tags: - "session" summary: "==>NOT IMPLEMENTED<== Fetch a Base64 encoded chunk of data from {tenantId},\ \ {sessionId}\n and {contentId}" description: "==>NOT IMPLEMENTED<== Fetch a Base64 encoded chunk of data from\ \ {tenantId}, {sessionId}\n and {contentId}" operationId: "onGetSessionContent" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" - name: "contentId" in: "path" description: "The identifier of a server-side setContent" required: true schema: type: "string" responses: 200: description: "A Base64 encoded chunk of data from {tenantId}, {sessionId}\ \ and {contentId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.LargeProperty" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" post: tags: - "session" summary: "Fetch a Base64 encoded chunk of data from {tenantId}, {sessionId}\ \ and {contentId}" description: "Fetch a Base64 encoded chunk of data from {tenantId}, {sessionId}\ \ and {contentId}" operationId: "onPostSessionContent" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for\ \ a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user\ \ session" required: true schema: type: "string" - name: "contentId" in: "path" description: " The identifier of a server-side setContent" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ReadLargePropertyParameters" responses: 200: description: "A Base64 encoded chunk of data from {tenantId}, {sessionId}\ \ and {contentId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.LargeProperty" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/tenantWorkbenches: post: tags: - "" summary: "Fetch All Workbenches" description: "Fetch All Workbenches" operationId: "onGetAllWorkbenches" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SaltParameters" responses: 200: description: "Returns All Workbenches" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.ArrayResult" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/uploadSaltImage: post: tags: - "" summary: "Upload salt Image" description: "Upload salt Image" operationId: "uploadSaltImage" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a\ \ tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.SaltFileUploadParameters" responses: 200: description: "Returns salt image upload status message" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/workbenches: get: tags: - "workbench" summary: "Return a list of active workbenches at {tenantId} and {sessionId}" description: "Return a list of active workbenches at {tenantId} and {sessionId}" operationId: "onGetWorkbenches" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: "The identifier of a server-side user session" required: true schema: type: "string" responses: 200: description: "List of active workbenches at {tenantId} and {sessionId}" content: application/json: schema: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Workbench" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/workbenches/{workbenchId}: get: tags: - "workbench" summary: "Return the workbench at {tenantId}, {sessionId} and {workbenchId}" description: "Return the workbench at {tenantId}, {sessionId} and {workbenchId}" operationId: "onGetWorkbench" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "workbenchId" in: "path" description: "The identifier of a server-side workbench" required: true schema: type: "string" responses: 200: description: "Workbench at {tenantId}, {sessionId}, and {workbenchId}" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Workbench" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/workbenches/{workbenchId}/actions: get: tags: - "action" summary: "==>NOT IMPLEMENTED<== Return a list of workbench actions at {tenantId},\ \ {sessionId} and {\n workbenchId}" description: "==>NOT IMPLEMENTED<== Return a list of workbench actions at {tenantId},\ \ {sessionId} and {\n workbenchId}" operationId: "onGetWorkbenchActions" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "workbenchId" in: "path" description: "The identifier of a server-side workbench" required: true schema: type: "string" responses: 200: description: "List of workbench actions at {tenantId}, {sessionId} and {workbenchId}" content: application/json: schema: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.WorkbenchAction" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/workbenches/{workbenchId}/actions/{actionId}: post: tags: - "action" summary: "Perform workbench action at {tenantId}, {sessionId}, {workbenchId}\ \ and {actionId}" description: "Perform workbench action at {tenantId}, {sessionId}, {workbenchId}\ \ and {actionId}" operationId: "onPostWorkbenchAction" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "workbenchId" in: "path" description: "The identifier of a server-side workbench" required: true schema: type: "string" - name: "actionId" in: "path" description: " The identifier of a server-side action" required: true schema: type: "string" responses: 200: description: "Workbench action at {tenantId}, {sessionId}, {workbenchId}\ \ and {actionId}\n completed successfully" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.Redirection" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" /v0/tenants/{tenantId}/sessions/{sessionId}/workbenches/{workbenchId}/graph/{launcherId}: post: tags: - "" summary: "Fetch Workbench launcher graph" description: "Fetch Workbench launcher graph" operationId: "getWorkbenchLauncherGraph" parameters: - name: "tenantId" in: "path" description: " The well-known public identifier for a tenant" required: true schema: type: "string" - name: "sessionId" in: "path" description: " The identifier of a server-side user session" required: true schema: type: "string" - name: "workbenchId" in: "path" description: " The identifier of a workbench" required: true schema: type: "string" - name: "launcherId" in: "path" description: " The identifier of a launcher" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.configuration.DesignParameters" responses: 200: description: "Returns Workbench launcher graph" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.configuration.WorkbenchLauncherGraph" 400: description: "Bad Request" content: application/json: schema: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" components: schemas: hxgn.api.dialog.ActionParameters: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.ActionParameters" targets: type: "array" - $ref: "#/components/schemas/hxgn.api.dialog.PendingWrites" description: "@author Glenn Osborne" hxgn.api.dialog.Annotation: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Annotation" name: type: "string" value: type: "string" description: "@author Glenn Osborne" hxgn.api.dialog.AppWindow: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.AppWindow" initialAction: type: "object" notificationsAction: type: "object" windowHeight: type: "integer" windowWidth: type: "integer" windowTitle: type: "string" workbenches: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Workbench" description: "@author Glenn Osborne" hxgn.api.dialog.ArrayResult: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.ArrayResult" arrayResult: type: "array" items: $ref: "#/components/schemas/?" hxgn.api.dialog.AttributeCellValue: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.AttributeCellValue" displayMediaInline: type: "boolean" autoFillCapable: type: "boolean" actions: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Menu" displayLength: type: "integer" entryMethod: type: "string" enum: - "ENTRY_METHOD_COMBO_BOX" - "ENTRY_METHOD_DROP_DOWN" - "ENTRY_METHOD_TEXT_FIELD" - "ENTRY_METHOD_ICON_CHOOSER" - "ENTRY_METHOD_CHECKBOX" - "ENTRY_METHOD_RADIO_BUTTONS" - "ENTRY_METHOD_TOGGLE" - "ENTRY_METHOD_TOGGLE_WITH_LABELS" - "ENTRY_METHOD_TOGGLE_ACTIVE_LABEL_LEFT" - "ENTRY_METHOD_TOGGLE_ACTIVE_LABEL_RIGHT" hint: type: "string" propertyName: type: "string" toolTip: type: "string" readOnlyDisplayMethod: type: "string" enum: - "DISPLAY_METHOD_LABEL" - "DISPLAY_METHOD_USE_ENTRY_METHOD" - $ref: "#/components/schemas/hxgn.api.dialog.CellValue" description: "Defines how to present a domain property through a UI component" hxgn.api.dialog.AvailableValuesParameters: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.AvailableValuesParameters" target: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.PendingWrites" description: "A purely declarative type. This object has no additional properties." hxgn.api.dialog.BarcodeScan: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.BarcodeScan" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "A purely declarative type. This object has no additional properties." hxgn.api.dialog.BrowserRedirection: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.BrowserRedirection" httpStatusCode: type: "integer" location: type: "string" hxgn.api.dialog.Calendar: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.Calendar" descriptionPropertyName: type: "string" endDatePropertyName: type: "string" endTimePropertyName: type: "string" initialStyle: type: "string" occurDatePropertyName: type: "string" occurTimePropertyName: type: "string" startDatePropertyName: type: "string" startTimePropertyName: type: "string" initialWeekDay: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "An abstract visual Calendar" hxgn.api.dialog.Cell: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Cell" values: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.CellValue" description: "@author Glenn Osborne" hxgn.api.dialog.CellValue: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SubstitutionCellValue" - "hxgn.api.dialog.CellValue" - "hxgn.api.dialog.ForcedLineCellValue" - "hxgn.api.dialog.LabelCellValue" - "hxgn.api.dialog.AttributeCellValue" style: type: "string" description: "@author Glenn Osborne" hxgn.api.dialog.CodeRef: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.CodeRef" code: type: "string" description: type: "string" description: "@author Glenn Osborne" hxgn.api.dialog.Column: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Column" displayMediaInline: type: "boolean" description: "This optional value is used to request that a media type,\ \ such as an Image, be displayed inline instead of using a hyperlink or\ \ button." heading: type: "string" propertyName: type: "string" initialDisplay: type: "string" headingGroup: type: "string" maintainable: type: "boolean" spacer: type: "boolean" defaultActionId: type: "string" entryMethod: type: "string" enum: - "ENTRY_METHOD_COMBO_BOX" - "ENTRY_METHOD_DROP_DOWN" - "ENTRY_METHOD_TEXT_FIELD" - "ENTRY_METHOD_ICON_CHOOSER" - "ENTRY_METHOD_CHECKBOX" - "ENTRY_METHOD_RADIO_BUTTONS" - "ENTRY_METHOD_TOGGLE" - "ENTRY_METHOD_TOGGLE_WITH_LABELS" - "ENTRY_METHOD_TOGGLE_ACTIVE_LABEL_LEFT" - "ENTRY_METHOD_TOGGLE_ACTIVE_LABEL_RIGHT" readOnlyDisplayMethod: type: "string" enum: - "DISPLAY_METHOD_LABEL" - "DISPLAY_METHOD_USE_ENTRY_METHOD" description: "" hxgn.api.dialog.ContentRedirection: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.ContentRedirection" fileName: type: "string" contentType: type: "string" url: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.Redirection" description: "@author Glenn Osborne" hxgn.api.dialog.Details: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.Details" gmlMarkup: type: "string" paperMarkup: type: "string" cancelButtonText: type: "string" commitButtonText: type: "string" editable: type: "boolean" focusPropertyName: type: "string" rows: type: "array" items: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Cell" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "A abstract definition for small visual area populated with labels\ \ and values. Labels are typically presented as simple text phrases. Values\ \ are usually presented inside a UI component, such as a TextField or ComboBox." hxgn.api.dialog.Dialog: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.EditorDialog" - "hxgn.api.dialog.QueryDialog" - "hxgn.api.dialog.Dialog" logger: type: "object" availableViews: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.ViewDescriptor" children: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Dialog" description: type: "string" dialogAlias: type: "string" description: "@deprecated -- use dialogName instead" dialogAliasPath: type: "object" description: "@deprecated -- use dialogOrigin instead" dialogName: type: "string" dialogOrigin: type: "object" header: type: "object" id: type: "string" offlineMode: type: "string" persistentId: type: "string" persistentIdPath: type: "object" positionalQueryAbility: type: "string" recordDef: type: "object" referringObject: type: "object" rootDialogId: type: "string" description: "The dialogId of the root dialog" rootDialogName: type: "string" description: "The dialogName of the root dialog" rootPersistentId: type: "string" description: "The persistentID of the root dialog" selectedViewId: type: "string" supportsColumnStatistics: type: "boolean" supportsPositionalQueries: type: "boolean" view: type: "object" quickSearchAllowed: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.DialogBase" description: "@author Glenn Osborne" hxgn.api.dialog.DialogBase: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Redirection" - "hxgn.api.dialog.DialogBase" - "hxgn.api.dialog.Dialog" dialogClassName: type: "string" dialogMode: type: "string" enum: - "COPY" - "CREATE" - "DELETE" - "DESTROYED" - "LIST" - "READ" - "UPDATE" - "FIND" domainClassName: type: "string" dialogType: type: "string" enum: - "EDITOR" - "QUERY" recordId: type: "string" sessionId: type: "string" tenantId: type: "string" viewMode: type: "string" enum: - "READ" - "WRITE" description: "@author Glenn Osborne" hxgn.api.dialog.DialogId: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.DialogId" dialogId: type: "string" hxgn.api.dialog.DialogMessage: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.DialogMessage" cause: type: "object" description: "An object typically provided to help programmers diagnose\ \ an error. For example, a cause can be the name of a host programming\ \ exception." children: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.DialogMessage" description: "If this message is a generalization or aggregation, then children\ \ messages can be used to explain the individual facets." code: type: "string" description: "A short language-independent identifier" message: type: "string" description: "A human-readable informative description. If a code is provided,\ \ then this message explains the meaning of the code." messageType: type: "string" enum: - "CONFIRMATION" - "ERROR" - "INFORMATION" - "WARNING" description: "CONFIRMATION, ERROR, INFORMATION, WARNING" propertyNames: type: "array" items: type: "string" description: "This property is provided when the message pertains to one\ \ or more properties in a user interface view." stackTrace: type: "string" description: "If the case of a host programming error, this property contains\ \ a stack trace of the host programming language." objectId: type: "string" hxgn.api.dialog.DialogRedirection: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.DialogRedirection" dialogAlias: type: "string" description: "@deprecated -- use dialogName instead" dialogDescription: type: "string" dialogId: type: "string" dialogName: type: "string" offlineMode: type: "string" persistentId: type: "string" selectedViewId: type: "string" displayHint: type: "string" quickSearchAllowed: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.Redirection" description: "@author Glenn Osborne" hxgn.api.dialog.EditorDialog: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.EditorDialog" - "hxgn.api.dialog.EditorSampleData" sideEffectedWrites: type: "object" - $ref: "#/components/schemas/hxgn.api.dialog.Dialog" description: "A purely declarative type. This object has no additional properties." hxgn.api.dialog.EditorSampleData: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.EditorSampleData" record: type: "object" dialogDeepLink: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.EditorDialog" hxgn.api.dialog.Filter: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Filter" not: type: "boolean" operand1: type: "object" operand2: type: "object" operator: type: "string" enum: - "AND" - "CONTAINS" - "ENDS_WITH" - "EQUAL_TO" - "GREATER_THAN" - "GREATER_THAN_OR_EQUAL_TO" - "LESS_THAN" - "LESS_THAN_OR_EQUAL_TO" - "NOT_EQUAL_TO" - "OR" - "STARTS_WITH" hxgn.api.dialog.ForcedLineCellValue: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.ForcedLineCellValue" - $ref: "#/components/schemas/hxgn.api.dialog.CellValue" description: "A purely declarative type. This object has no additional properties." hxgn.api.dialog.GpsReading: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.GpsReading" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "This view is used to read a GPS location. This view is a purely\ \ declarative type and has no additional properties." hxgn.api.dialog.GpsReadingProperty: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.GpsReadingProperty" accuracy: type: "number" latitude: type: "number" longitude: type: "number" source: type: "string" description: "@author Glenn Osborne" hxgn.api.dialog.Graph: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.Graph" dataPoints: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.GraphDataPoint" displayQuadrantLines: type: "boolean" filterDataPoints: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.GraphDataPoint" graphType: type: "string" groupingDataPoint: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.GraphDataPoint" identityDataPoint: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.GraphDataPoint" sampleModel: type: "string" xAxisLabel: type: "string" xAxisRangeFrom: type: "integer" xAxisRangeTo: type: "integer" yAxisLabel: type: "string" yAxisRangeFrom: type: "integer" yAxisRangeTo: type: "integer" startDateDataPoint: type: "object" startTimeDataPoint: type: "object" startDateTimeDataPoint: type: "object" endDateDataPoint: type: "object" endTimeDataPoint: type: "object" endDateTimeDataPoint: type: "object" legends: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.GraphLegend" hoverDetails: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.GraphHoverDetail" xAxisRangeFromDateTime: type: "string" xAxisRangeToDateTime: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "A view describing how to display a collection of data as a line\ \ graph, pie chart, bar chart, etc." hxgn.api.dialog.GraphDataPoint: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.GraphDataPoint" bubbleRadiusName: type: "string" bubbleRadiusType: type: "string" enum: - "INT" - "LONG" - "DECIMAL" - "DOUBLE" legendKey: type: "string" plotType: type: "string" enum: - "BAR" - "PIE" - "BUBBLE" - "LINE" - "SCATTER" - "STACKED_BAR" - "DONUT" - "GANTT" propertyName: type: "string" seriesColor: type: "string" xAxisName: type: "string" xAxisType: type: "string" enum: - "INT" - "LONG" - "DECIMAL" - "DOUBLE" maintainable: type: "boolean" description: "@author Glenn Osborne" hxgn.api.dialog.GraphHoverDetail: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.GraphHoverDetail" propertyName: type: "string" label: type: "string" hxgn.api.dialog.GraphLegend: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.GraphLegend" seriesColor: type: "string" label: type: "string" hxgn.api.dialog.ImagePicker: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.ImagePicker" urlPropName: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "Columns, filter and sorts for a UI list component." hxgn.api.dialog.KeyValuePair: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.KeyValuePair" key: type: "string" value: type: "string" hxgn.api.dialog.LabelCellValue: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.LabelCellValue" value: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.CellValue" description: "A text description typically preceeding a UI component as a prompt" hxgn.api.dialog.LargeProperty: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.LargeProperty" byteCount: type: "integer" description: "Number of bytes in data after decoding." contentType: type: "string" description: "Content type defines the format of the decoded Base64 data." encodedData: type: "string" description: "Base64 encoded data. This 'data' property may be empty (length\ \ == 0) while the 'hasMore' property is true. This combination serves\ \ as a placeholder used to defer the control of downloading large data\ \ to the client. Query results that contain images, for example, may return\ \ placeholders because it's not desirable to return all images for all\ \ rows." hasMore: type: "boolean" url: type: "string" description: "A URL indicates that the data must be downloaded indirectly\ \ through an address and not through the dialog API." description: "@author Glenn Osborne" hxgn.api.dialog.List: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.List" columns: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Column" columnStyle: type: "string" fixedColumnCount: type: "integer" filter: type: "object" gmlMarkup: type: "string" sort: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Sort" style: type: "string" persistentId: type: "string" suppressHeading: type: "boolean" spacerLines: type: "integer" pagingMethod: type: "string" definedPageStyle: type: "string" pageSize1: type: "integer" pageSize2: type: "integer" pageSize3: type: "integer" pagingPersistentId: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "Columns, filter and sorts for a UI list component." hxgn.api.dialog.Login: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Login" NEW_PASSWORD: type: "string" clientType: type: "string" enum: - "MOBILE" - "DESKTOP" description: "enum DESKTOP/MOBILE" deviceProperties: type: "object" description: "The deviceProperties object is arbitrary, its values are dynamically\ \ defined\n and it is used to pass contextual information to the underlying\ \ application\n software." password: type: "string" description: "A 'userId' and 'password' combination can be used to authenticate\ \ a user as alternative to the more sophisticated technique that uses\ \ a 'permissionToken' and 'proofKey'." permissionToken: type: "string" description: "A 'permissionToken' and 'proofKey' combination can be used\ \ to authenticate a user as alternative to the simplistic technique that\ \ uses a 'userId' and 'password'." proofKey: type: "string" description: "A 'permissionToken' and 'proofKey' combination can be used\ \ to authenticate a user as alternative to the simplistic technique that\ \ uses a 'userId' and 'password'." userId: type: "string" description: "A 'userId' and 'password' combination can be used to authenticate\ \ a user as alternative to the more sophisticated technique that uses\ \ a 'permissionToken' and 'proofKey'." changePasswordFields: type: "object" description: "The passwordFields object is for getting any additional fields\ \ w.r.t. change password usecase" IS_REQUIRED: type: "string" description: "@author Glenn Osborne" hxgn.api.dialog.Map: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.Map" cityPropertyName: type: "string" descriptionPropertyName: type: "string" latitudePropertyName: type: "string" longitudePropertyName: type: "string" postalCodePropertyName: type: "string" statePropertyName: type: "string" streetPropertyName: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "@author Glenn Osborne" hxgn.api.dialog.MapLocation: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.MapLocation" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "This view is used to enter a Map location. This view is a purely\ \ declarative type and has no additional properties." hxgn.api.dialog.MapLocationProperty: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.MapLocationProperty" latitude: type: "number" longitude: type: "number" description: "@author Glenn Osborne" hxgn.api.dialog.Menu: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Menu" actionId: type: "string" children: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Menu" directive: type: "string" description: "A special value understood by the UI, such as 'refresh'" id: type: "string" iconUrl: type: "string" label: type: "string" offlineMode: type: "string" modes: type: "array" items: type: "string" description: "The menu is allowed (active) for these modes" multiSelectAvailable: type: "boolean" description: "boolean that returns true if multiple selections can be passed\ \ to the menu action (false if only zero or one selected record can be\ \ passed)." selectionRequired: type: "boolean" description: "boolean that returns true if a selection is required to perform\ \ the menu action (false if selection is not required)" visible: type: "boolean" clientFunction: type: "string" description: "Indicator only for menu actions that the client should perform" description: "@author Glenn Osborne" hxgn.api.dialog.NFCScan: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.NFCScan" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "A purely declarative type. This object has no additional properties." hxgn.api.dialog.NullRedirection: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.NullRedirection" dialogAlias: type: "string" description: "@deprecated -- use dialogName instead" dialogName: type: "string" persistentId: type: "string" refreshNeeded: type: "boolean" - $ref: "#/components/schemas/hxgn.api.dialog.Redirection" description: "@author Glenn Osborne" hxgn.api.dialog.OAuthParameters: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.OAuthParameters" clientState: type: "string" xhaRedirectURL: type: "string" hxgn.api.dialog.ObjectRef: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.ObjectRef" description: type: "string" objectId: type: "string" description: "@author Glenn Osborne" hxgn.api.dialog.OfflineStatus: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.OfflineStatus" clientShouldCrawl: type: "boolean" id: type: "string" elapsedTime: type: "integer" description: "A purely declarative type. This object has no additional properties." hxgn.api.dialog.PasswordFields: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.PasswordFields" password: type: "string" newPassword: type: "string" IS_REQUIRED: type: "string" hxgn.api.dialog.PendingWrites: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.PendingWrites" - "hxgn.api.dialog.SideEffectsParameters" - "hxgn.api.dialog.ActionParameters" - "hxgn.api.dialog.WriteLargePropertyParameters" - "hxgn.api.dialog.ReadLargePropertyParameters" - "hxgn.api.dialog.AvailableValuesParameters" pendingWrites: type: "object" description: "@author Glenn Osborne" hxgn.api.dialog.PowerBI: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.PowerBI" accessToken: type: "string" embedId: type: "string" embedType: type: "string" embedUrl: type: "string" permissions: type: "string" tokenType: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "" hxgn.api.dialog.Property: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Property" annotations: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Annotation" format: type: "string" enum: - "INT32" - "INT64" - "FLOAT" - "DOUBLE" - "DECIMAL" - "INTEGER" - "DATE" - "DATE_TIME" - "TIME" - "PASSWORD" description: "The format property further describes the value using names\ \ that correlate, when possible, to the Open API formats. Some example\ \ format values are 'date', 'date-time', 'uuid', 'int32' and 'int64'.\ \ The format value 'decimal' is used to describe a string holding an arbitrary\ \ precision binary-coded-decimal value. Likewise, the format value 'integer'\ \ is used to describe a string holding an arbitrary precision integer\ \ value. For more information, see the Open API Spec at https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md" name: type: "string" value: type: "object" description: "An instance of one of the following: boolean, string, decimal,\ \ integer, float, date, time, date-time, code-ref, object-ref, gps-reading,\ \ map-location, null." description: "@author Glenn Osborne" hxgn.api.dialog.PropertyDef: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.PropertyDef" STRING: type: "string" DECIMAL: type: "string" DOUBLE: type: "string" FLOAT: type: "string" LONG: type: "string" INT: type: "string" cardinality: type: "string" description: "The canCauseSideEffects meta property indicates that writing\ \ to this property can cause LOCAL side effects (on\n the same domain\ \ object). For example, changing a 'zipCode' property case cause the 'state'\ \ property to change. If\n a user interface changes a property that can\ \ cause side effects, it should refresh the associated domain view." canCauseSideEffects: type: "boolean" description: "An optional value, that when present, indicates the property\ \ is an array. The valid cardinality values are *\n (zero or more), +\ \ (one or more), or a number indicating the fixed number of elements in\ \ the array." contentType: type: "string" description: "Content type further defines the physical format of large\ \ binaries and file types. Content type is similar to the\n 'format' property,\ \ which further defines primitive types." displayLength: type: "integer" description: "Length of a type to be displayed. Some types are longer than\ \ what is practically needed by the application. This\n property is used\ \ to define the practical length used in user interfaces." format: type: "string" description: "The format property further describes the value using names\ \ that correlate, when possible, to the Open API\n formats. Some example\ \ format values are 'date', 'date-time', 'uuid', 'int32' and 'int64'.\ \ The format value\n 'decimal' is used to describe a string holding an\ \ arbitrary precision binary-coded-decimal value. Likewise, the\n format\ \ value 'integer' is used to describe a string holding an arbitrary precision\ \ integer value. For more\n information, see the Open API Spec at https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md" length: type: "integer" description: "Length of a type. This can be the length of a string or the\ \ length of a decimal." propertyName: type: "string" description: "The name of a domain property" propertyType: type: "string" description: "The property type of value contained in a record. A valid\ \ type is either one of the OpenAPI basic values [boolean\n integer null\ \ number object string] or a fully qualified type name that can be retrieved\ \ from the schema service.\n Note that array types are declared using\ \ the `cardinality` property." scale: type: "integer" description: "Scale of a decimal type to be displayed. Some decimal types\ \ are longer than what is practically needed by the\n application. This\ \ property is used to define the practical scale used in user interfaces." semanticType: type: "string" description: "Whereas 'type' and 'format' define the physical meaning of\ \ a property, the 'semanticType' adds meainingful\n insight into the usage\ \ of the property. For example, a 'decimal' type may be further defined\ \ semantically as a\n 'money' type." upperCaseOnly: type: "boolean" description: "Does this property require that all characters in a string\ \ be upper case?" writeAllowed: type: "boolean" description: "Can this property ever have its value written? User interfaces\ \ typically use 'writeAllowed' to chose between an\n edit control or display-only\ \ control." writeEnabled: type: "boolean" description: "Can this property currently have its value written? User interfaces\ \ will typically show this property in an edit\n control if 'writeAllowed'\ \ is true and then protect it or unprotect it based on 'writeEnabled'." booleanFalseAlias: type: "string" booleanTrueAlias: type: "string" datePresentationFormat: type: "string" description: "A property definition describes a particular value of a domain\ \ entity. Domain entities are transacted as records,\n therefore properties\ \ and lists of properties are referred to as fields and records. Moreover,\ \ a list of property\n definitions is referred to as a record definition and\ \ is the metadata describing the read/write capabilities of a\n specific dialog\ \ model in use by a specific user in a specific workflow." hxgn.api.dialog.PropertyName: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.PropertyName" propertyName: type: "string" hxgn.api.dialog.QueryActionParameters: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.QueryActionParameters" pendingWrites: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Record" hxgn.api.dialog.QueryDialog: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.QueryDialog" - "hxgn.api.dialog.QuerySampleData" positionQueryAbility: type: "string" enum: - "FULL" - "NONE" - $ref: "#/components/schemas/hxgn.api.dialog.Dialog" hxgn.api.dialog.QueryParameters: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.QueryParameters" fetchDirection: type: "string" enum: - "FORWARD" - "BACKWARD" fetchMaxRecords: type: "integer" description: "Mimimum 1" fromRecordId: type: "string" description: "A query proceeds in the fetchDirection *FORWARD or BACKWARD) starting\ \ at fromRecordId and returns at most fetchMaxRecords." hxgn.api.dialog.QuerySampleData: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.QuerySampleData" views: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.QuerySampleData" records: type: "object" - $ref: "#/components/schemas/hxgn.api.dialog.QueryDialog" hxgn.api.dialog.ReadLargePropertyParameters: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.ReadLargePropertyParameters" recordId: type: "string" maxBytes: type: "integer" sequence: type: "integer" - $ref: "#/components/schemas/hxgn.api.dialog.PendingWrites" description: "@author Glenn Osborne" hxgn.api.dialog.Record: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Record" annotations: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Annotation" dialogAlias: type: "string" description: "@deprecated use dialogName instead" dialogName: type: "string" id: type: "string" offlineMode: type: "string" persistentId: type: "string" persistentIdPath: type: "object" properties: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Property" sessionValues: type: "object" description: "@author Glenn Osborne" hxgn.api.dialog.RecordDef: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.RecordDef" propertyDefs: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.PropertyDef" description: "@author Glenn Osborne" hxgn.api.dialog.RecordSet: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.RecordSet" defaultActionId: type: "string" dialogAlias: type: "string" description: "@deprecated -- use dialogName instead" dialogName: type: "string" offlineMode: type: "string" persistentId: type: "string" persistentIdPath: type: "object" hasMore: type: "boolean" records: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.Record" sessionValues: type: "object" description: "@author Glenn Osborne" hxgn.api.dialog.Redirection: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.Redirection" - "hxgn.api.dialog.WorkbenchRedirection" - "hxgn.api.dialog.NullRedirection" - "hxgn.api.dialog.DialogRedirection" - "hxgn.api.dialog.ContentRedirection" id: type: "string" description: "A unique id for this redirection." referringObject: type: "object" refreshNeeded: type: "boolean" - $ref: "#/components/schemas/hxgn.api.dialog.DialogBase" description: "@author Glenn Osborne" hxgn.api.dialog.ReferringDialog: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.ReferringDialog" dialogAlias: type: "string" description: "@deprecated -- use DialogName" dialogId: type: "string" description: "The dialogId of the referring dialog" dialogMode: type: "string" enum: - "COPY" - "CREATE" - "DELETE" - "DESTROYED" - "LIST" - "READ" - "UPDATE" - "FIND" dialogName: type: "string" dialogType: type: "string" enum: - "EDITOR" - "QUERY" description: "The type of the referring dialog" offlineMode: type: "string" description: "The offline capabilities of a dialog Model\n @value {Offline}\ \ – This dashboard will automatically be taken offline. All Dashboard\ \ Sections for this Dashboard that contain Explicit/Implicit Data Objects\ \ will also be taken offline.\n @value {Online Only} – This Dashboard\ \ cannot be taken offline" persistentId: type: "string" description: "persistentId will be used instead of dialogAlias to identify\ \ the launcher (dialogAlias will continue to be provided for the hardcoded\ \ SDx application but will be deprecated)." persistentIdPath: type: "object" description: "persistentIdPath will be used instead of dialogAliasPath\ \ to identify the launcher (dialogAliasPath will continue to be provided\ \ for the hardcoded SDx application but will be deprecated)" recordId: type: "string" description: "The record id of the referring dialog if it's an 'EditorDialog'" rootDialogId: type: "string" description: "The dialogId of the referring dialog's root dialog" rootDialogName: type: "string" description: "The dialogName of the referring dialog's root dialog" rootPersistentId: type: "string" description: "The persistentID of the referring dialog's root dialog" - $ref: "#/components/schemas/hxgn.api.dialog.ReferringObject" description: "@author Glenn Osborne" hxgn.api.dialog.ReferringObject: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.ReferringDialog" - "hxgn.api.dialog.ReferringWorkbench" - "hxgn.api.dialog.ReferringObject" actionId: type: "string" description: "The workbench actionId or menu actionId of the referring object" dialogProperties: type: "object" description: "Dialogs are created by either a workbench action or a menu action.\ \ ReferringObject is used to capture what caused the action and the state\ \ of the invoker." hxgn.api.dialog.ReferringWorkbench: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.ReferringWorkbench" workbenchId: type: "string" description: "The workbenchId of the referring workbench" - $ref: "#/components/schemas/hxgn.api.dialog.ReferringObject" description: "@author Glenn Osborne" hxgn.api.dialog.SaltDocument: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SaltDocument" saltDocumentName: type: "string" saltDocument: type: "object" hxgn.api.dialog.SaltDocumentName: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SaltDocumentName" name: type: "string" description: type: "string" hxgn.api.dialog.SaltFileUploadParameters: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SaltFileUploadParameters" fileName: type: "string" description: "Name of the File" fileData: type: "string" description: "Base64 encoded data." resourceType: type: "string" description: "Image types" description: "@author Glenn Osborne" hxgn.api.dialog.SaltImageName: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SaltImageName" name: type: "string" url: type: "string" hxgn.api.dialog.SaltParameters: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SaltParameters" documentName: type: "string" documentDescription: type: "string" saltDocument: type: "object" resourceType: type: "string" additionalProperties: type: "object" newDocumentName: type: "string" hxgn.api.dialog.Session: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Session" PLATFORM_KEY: type: "string" logger: type: "object" appVendors: type: "array" items: type: "string" appVersion: type: "string" description: "Current version of the underlying application (domain) logic.\ \ This is not the middleware version." appWindow: type: "object" offlineStatus: type: "object" description: "The SessionService Offline/Online model. This contains information\ \ for going on/offline and whether the client should crawl" currentDivision: type: "string" description: "Current division is analagous to a \"sub-tenant\" and it's\ \ possible for users to tailor different desktops based on their division." changePasswordMessage: type: "string" description: "Message to be sent back to ui when there is an impending password\ \ expiry" id: type: "string" secretKey: type: "string" description: "A secret key shared just once but used on all requests to\ \ create cryptographic signatures." serverAssignment: type: "string" description: "The dialog layer interacts with an application endpoint, transparent\ \ to the user interface. The serverAssignment is not used by the user\ \ interface directly, but this value can be useful when diagnosing problems." serverVersion: type: "string" description: "Current version of the underlying middleware (not the application\ \ logic)" tenantId: type: "string" userId: type: "string" serviceAddress: type: "object" dialogServerVersion: type: "string" deviceProperties: type: "object" authLogin: type: "object" tenantProperties: type: "object" description: "The tenantProperties object is arbitrary, its values are dynamically\ \ defined and it is used to return tenant-specific values to the requesting\ \ client." description: "@author Glenn Osborne" hxgn.api.dialog.SessionCount: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SessionCount" count: type: "integer" hxgn.api.dialog.SessionCountResult: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SessionCountResult" count: type: "integer" hxgn.api.dialog.SessionId: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SessionId" sessionId: type: "string" postLogoutURL: type: "string" additionalPostLogoutURLs: type: "array" items: type: "string" hxgn.api.dialog.SideEffectsParameters: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.SideEffectsParameters" property: type: "object" - $ref: "#/components/schemas/hxgn.api.dialog.PendingWrites" description: "Side effects parameters are passed to the side effects API. The\ \ side effects API is intended to be used during data entry. When the user\ \ changes a property that can produce side effects, the application calls\ \ the side effects API to forecast side effects. The application then propagates\ \ the forecasted side effects through the data entry form. An example use\ \ case is changing a zip code for USA postal address. The forecasted side\ \ effects will include a new state identifier, and maybe a new city name." hxgn.api.dialog.SideEffectsResponse: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.SideEffectsResponse" propertyName: type: "string" record: type: "object" recordDef: type: "object" description: "@author Glenn Osborne" hxgn.api.dialog.Sort: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Sort" direction: type: "string" enum: - "ASC" - "DESC" propertyName: type: "string" hxgn.api.dialog.Status: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Status" status: type: "string" hxgn.api.dialog.Stream: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.Stream" bufferSize: type: "integer" topic: type: "string" view: type: "object" - $ref: "#/components/schemas/hxgn.api.dialog.View" hxgn.api.dialog.SubstitutionCellValue: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.SubstitutionCellValue" value: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.CellValue" description: "A text template containing substitution parameters that is instantiated\ \ at presentation time and filled with domain values." hxgn.api.dialog.Tenant: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Tenant" id: type: "string" description: type: "string" hxgn.api.dialog.TenantCapabilities: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.TenantCapabilities" availableLanguages: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.CodeRef" defaultBrandingLoginJSON: type: "string" detectJailbrokenDevices: type: "boolean" mdmApiEnabled: type: "boolean" oauthAuthorizationAvailable: type: "boolean" restApiEnabled: type: "boolean" savePasswordAllowed: type: "boolean" serverVersion: type: "string" description: "Current version of the underlying middleware (not the application\ \ logic)" translationAvailable: type: "boolean" oAuthExpectModelAuthorizationResult: type: "boolean" oAuthAuthorizationUrl: type: "string" description: "The description of the tenant branding and initialization information\ \ available before login" hxgn.api.dialog.View: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Graph" - "hxgn.api.dialog.Viz" - "hxgn.api.dialog.ImagePicker" - "hxgn.api.dialog.GpsReading" - "hxgn.api.dialog.PowerBI" - "hxgn.api.dialog.Map" - "hxgn.api.dialog.BarcodeScan" - "hxgn.api.dialog.Calendar" - "hxgn.api.dialog.View" - "hxgn.api.dialog.List" - "hxgn.api.dialog.VizGraphicId" - "hxgn.api.dialog.NFCScan" - "hxgn.api.dialog.Details" - "hxgn.api.dialog.MapLocation" - "hxgn.api.dialog.Stream" logger: type: "object" alias: type: "string" description: "An alternative identifier for this view. An alias is useful\ \ for identifying user interface components from within\n custom programming\ \ logic." defaultActionId: type: "string" id: type: "string" menu: type: "object" name: type: "string" label: type: "string" title: type: "string" persistentId: type: "string" saltDocument: type: "object" saltDocumentName: type: "string" persistentViewId: type: "string" persistentViewSectionId: type: "string" description: "@author Glenn Osborne" hxgn.api.dialog.ViewDescriptor: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.ViewDescriptor" id: type: "string" name: type: "string" title: type: "string" description: "@author Glenn Osborne" hxgn.api.dialog.ViewMode: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.ViewMode" mode: type: "string" enum: - "READ" - "WRITE" hxgn.api.dialog.Viz: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.Viz" parentId: type: "string" parentName: type: "string" modelProperties: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.VizProperty" componentProperties: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.VizProperty" adsFileAuthenticationBaseUrl: type: "string" adsBaseUri: type: "string" adsResourceUri: type: "string" adsFileClientId: type: "string" adsFileClientSecret: type: "string" vopClientId: type: "string" vopRedirectUrl: type: "string" url: type: "string" authorizationType: type: "string" enum: - "OAUTH20" - "SAM" vopClientSecret: type: "string" monikerTemplate: type: "string" sourceType: type: "string" graphicType: type: "string" vdsBaseUri: type: "string" graphicResourceUri: type: "string" adsFileAuthorizationType: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.View" description: "" hxgn.api.dialog.VizGraphicId: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.VizGraphicId" - $ref: "#/components/schemas/hxgn.api.dialog.View" hxgn.api.dialog.VizProperty: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.VizProperty" name: type: "string" valueType: type: "string" value: type: "string" hxgn.api.dialog.Workbench: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.Workbench" actions: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.WorkbenchAction" id: type: "string" name: type: "string" offlineCapable: type: "boolean" description: "@author Glenn Osborne" hxgn.api.dialog.WorkbenchAction: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.WorkbenchAction" actionId: type: "string" alias: type: "string" description: "An alternative unique identifier. An alias is typically used\ \ to identify an action that is used in offline mode.\n An alias should\ \ be more descriptive than the id, therefore an alias makes offline logic\ \ more descriptive.\n descriptive." iconBase: type: "string" id: type: "string" name: type: "string" offlineCapable: type: "boolean" workbenchId: type: "string" offlineMode: type: "string" persistentId: type: "string" description: "@author Glenn Osborne" hxgn.api.dialog.WorkbenchRedirection: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.WorkbenchRedirection" workbenchId: type: "string" - $ref: "#/components/schemas/hxgn.api.dialog.Redirection" description: "@author Glenn Osborne" hxgn.api.dialog.WriteLargePropertyParameters: type: "object" allOf: - properties: type: type: "string" enum: - "hxgn.api.dialog.WriteLargePropertyParameters" append: type: "boolean" description: "Append or replace property data." contentType: type: "string" description: "Content type defines the format of the decoded Base64 data." encodedData: type: "string" description: "Base64 encoded data." - $ref: "#/components/schemas/hxgn.api.dialog.PendingWrites" description: "@author Glenn Osborne" hxgn.api.dialog.configuration.ChildDialogNode: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.configuration.ChildDialogNode" persistentId: type: "string" persistentViewSectionId: type: "string" hxgn.api.dialog.configuration.DesignParameters: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.configuration.DesignParameters" additionalProperties: type: "object" clientType: type: "string" hxgn.api.dialog.configuration.DialogNode: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.configuration.DialogNode" dialogType: type: "string" title: type: "string" dialogDeepLink: type: "string" baseObjectDeepLink: type: "string" baseObjectTitle: type: "string" persistentId: type: "string" offlineCapable: type: "boolean" availableViews: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.configuration.NodeAvailableView" childDialogs: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.configuration.ChildDialogNode" actions: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.configuration.NodeAction" defaultLayout: type: "string" dialogSubType: type: "string" saltDocumentName: type: "string" saltDocument: type: "object" hxgn.api.dialog.configuration.GraphResponse: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.configuration.GraphResponse" responseType: type: "string" persistentId: type: "string" responseContents: type: "string" context: type: "string" hxgn.api.dialog.configuration.NodeAction: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.configuration.NodeAction" actionDeepLink: type: "string" actionId: type: "string" iconUrl: type: "string" label: type: "string" offlineCapable: type: "boolean" visibleOn: type: "array" items: type: "string" actionGraphResponses: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.configuration.GraphResponse" hxgn.api.dialog.configuration.NodeAvailableView: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.configuration.NodeAvailableView" persistentId: type: "string" name: type: "string" description: type: "string" viewId: type: "string" hxgn.api.dialog.configuration.WorkbenchLauncherGraph: type: "object" properties: type: type: "string" enum: - "hxgn.api.dialog.configuration.WorkbenchLauncherGraph" launcherName: type: "string" launcherPersistentId: type: "string" graphResponses: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.configuration.GraphResponse" crawlGraphs: type: "array" items: $ref: "#/components/schemas/hxgn.api.dialog.configuration.DialogNode" tags: - name: "action" description: "Navigation action that produces a workflow transition" - name: "dialog" description: "Server-side user interface controller" - name: "record" description: "Data structure of fields containing domain data" - name: "redirection" description: "Workflow transition to a new dialog" - name: "session" description: "Authenticated user session containing active dialogs" - name: "tenant" description: "Tentant specific data (Needed to brand a tenant's login)" - name: "view" description: "Abstract UI view (Form, List, Graph, Map, Details...)" - name: "workbench" description: "Context-sensitive list of actions for an authenticated user session" externalDocs: description: "Hexagon API Home Page" url: "https://www.hxgn-api.net"