Skip to main content

Get Editor Session Messages

GET 
/api/workspaces/:workspace_id/entities/:id/messages/

Fetch system and user messages within an editor session. User should have at least READ permission on the entity to fetch messages.

Request​

Path Parameters

    workspace_id stringrequired
    id integerrequired

    A unique integer value identifying this entity.

Query Parameters

    editor_session uuidrequired

    Session identifier (UUID)

Responses​

Schema

  • Array [

    • job_id integer

    Id of the job.

    created_at date-time

    Creation date of the job.

    job_label stringnullable

    Possible values: non-empty

    Human readable label of the job.

    job_method_type string

    Possible values: non-empty

    Job method type. It can be one of: geometry, plotly, data, optimise-button, image_and_data, step-next, plotly_and_data, ifc_and_data, geojson, svg_and_data, svg, analyse-button, web_and_data, ifc, pdf, set-params-button, image, download-button, geojson_and_data, web, geometry_and_data.

    completion_type string

    Possible values: non-empty

    Type of completion. It can be one of: result, stopped, expired, error, error_user.

    error_reported boolean

    Shows whether error is reported. Errors can be reported when job is finished with ERROR completion type.

    error_message stringnullable

    Possible values: non-empty

    Error message of the job if finished with ERROR_USER completion type.

    messages

    object[]

    required

    List of last messages.

  • Array [

    • message_type string

    Possible values: non-empty

    Type of the message. It can be one of success, info, warning, started, result, stopped, expired, error, error_user

    message string

    Possible values: non-empty

    Message content.

    timestamp date-time

    Timestamp of the message.

  • ]

  • ]

Loading...