document
v1
GET /api/v1/document/documents/{id}/actions/
Changed onRequest
- Base URL/ (relative, and the document was published on a file host, not at the API’s origin)
- AuthAPI key in header Authorization
- TypeScripthttps://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/document/documents/:id/actions/get.tsA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
A unique integer value identifying this document.
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
Example response
{
"status_name": "status_name",
"name": "name",
"project": 6,
"pk": 0,
"document_type": "document_type"
}Changes
- breaking
the response's body type changed from
arraytoobjectfor 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 required property
to the response with the status
- breaking
- info
endpoint added
- info