Skip to content
MoltaroMoltaroMoltaro Docs

Log a UI screen open event.

POST
/api/workspace/audit/ui/screens
curl --request POST \
  --url https://example.com/api/workspace/audit/ui/screens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ScreenKey": "example", "EntityType": "example", "EntityId": "example", "EntityName": "example", "WorkspaceUiPageKey": "example", "WorkspaceUiArtifactId": "example", "WorkspaceUiArtifactHash": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Section titled “Request Body”

Request payload for logging a UI screen view.

object
ScreenKey

Stable key of the UI screen.

string
nullable
EntityType

Optional entity type associated with the screen.

string
nullable
EntityId

Optional entity id associated with the screen.

string
nullable
EntityName

Optional entity display name associated with the screen.

string
nullable
WorkspaceUiPageKey

Workspace UI page key for the fixed Workspace UI screen.

string
nullable
WorkspaceUiArtifactId

Workspace UI artifact identity for the fixed Workspace UI screen.

string
nullable
WorkspaceUiArtifactHash

Workspace UI artifact hash for the fixed Workspace UI screen.

string
nullable
Examplegenerated
{
  "ScreenKey": "example",
  "EntityType": "example",
  "EntityId": "example",
  "EntityName": "example",
  "WorkspaceUiPageKey": "example",
  "WorkspaceUiArtifactId": "example",
  "WorkspaceUiArtifactHash": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data
boolean
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
Data
boolean
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}