common

GET /api/v1/common/actions/

Changed on Sep 22, 2021

Action List

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/common/actions/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

project_idinteger

Project ID

document_idinteger

Document ID

view_actionsstring[]

Action names

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

idinteger

namestring

messagestring nullable

view_actionstring nullable

object_pkstring nullable

model_namestring nullable

datestring date-time

user__namestring

user__initialsstring

user_photo_urlstring

request_dataobject nullable

Example response

[
  {
    "date": "2000-01-23T04:56:07.000+00:00",
    "user__name": "user__name",
    "view_action": "view_action",
    "model_name": "model_name",
    "name": "name",
    "id": 0,
    "message": "message",
    "user__initials": "user__initials",
    "request_data": "{}",
    "object_pk": "object_pk",
    "user_photo_url": "user_photo_url"
  }
]

Changes

Sep 22, 202163116f2e9e3e Revision changes
- breaking
  the response's property type changed from array to object for status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
May 24, 20218167164be9cc Revision changes
- breaking
  the response's property type changed from object to array for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the new optional query request parameter document_id
- info
  added the new optional query request parameter project_id
- info
  added the new optional query request parameter view_actions

Operation history (3 revisions)