Docs Portal

Error Reports

Retrieve Error Report

get

Retrieve a specific Error Report by ID

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200

Error Report retrieved successfully

application/json
get
GET /api/v1/error_reports/{id} HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-08-29T22:32:44.119Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text",
  "created_date": "2025-08-29T22:32:44.119Z",
  "updated_date": "2025-08-29T22:32:44.119Z"
}

Delete Error Report

delete

Delete a specific Error Report by ID

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
204

Error Report deleted

No content
delete
DELETE /api/v1/error_reports/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Partial Update Error Report

patch

Partial update a specific Error Report by ID

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
idintegerRead-onlyOptional

Error report ID

action_content_typeintegerRequired

Content type ID for action

action_object_idintegerRequired

Object ID for action

target_content_typeinteger | nullableOptional

Content type ID for target

target_object_idstring | nullableOptional

Object ID for target

obj_modified_datestring · date-timeRequired

Object modification date

error_codestring · max: 128Required

Error code

error_descstringRequired

Error description

is_okbooleanOptional

Status flag

Default: false
raw_requeststring | nullableOptional

Raw request data

raw_responsestring | nullableOptional

Raw response data

created_datestring · date-timeRead-onlyOptional

Creation timestamp

updated_datestring · date-timeRead-onlyOptional

Last update timestamp

Responses
200

Error Report updated

No content
patch
PATCH /api/v1/error_reports/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 336

{
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-08-29T22:32:44.119Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text"
}
No content

List Error Reports

get

List Error Reports

Authorizations
Query parameters
catalogstringOptional

Filter by catalog name

target_content_typestringOptional

Filter by target content type model name

target_content_type_idintegerOptional

Filter by target content type ID

target_object_idintegerOptional

Filter by target object ID

action_content_typestringOptional

Filter by action content type model name

action_content_type_idintegerOptional

Filter by action content type ID

action_object_id__ininteger[]Optional

Filter by multiple action object IDs

is_okbooleanOptional

Filter by status flag

Responses
200

List of Error Reports

application/json
get
GET /api/v1/error_reports/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "action_content_type": 1,
    "action_object_id": 1,
    "action": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "target_content_type": 1,
    "target_object_id": "text",
    "target": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "obj_modified_date": "2025-08-29T22:32:44.119Z",
    "error_code": "text",
    "error_desc": "text",
    "is_ok": false,
    "raw_request": "text",
    "raw_response": "text",
    "created_date": "2025-08-29T22:32:44.119Z",
    "updated_date": "2025-08-29T22:32:44.119Z"
  }
]

List City Error Reports

get

Get list of city error reports

Authorizations
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
Responses
200

List of City Error Reports

application/json
get
GET /api/v1/error_reports/city HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "action_content_type": 1,
    "action_object_id": 1,
    "action": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "target_content_type": 1,
    "target_object_id": "text",
    "target": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "obj_modified_date": "2025-08-29T22:32:44.119Z",
    "error_code": "text",
    "error_desc": "text",
    "is_ok": false,
    "raw_request": "text",
    "raw_response": "text",
    "created_date": "2025-08-29T22:32:44.119Z",
    "updated_date": "2025-08-29T22:32:44.119Z"
  }
]

List Township Error Reports

get

Get list of township error reports

Authorizations
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
Responses
200

List of Township Error Reports

application/json
get
GET /api/v1/error_reports/township/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "action_content_type": 1,
    "action_object_id": 1,
    "action": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "target_content_type": 1,
    "target_object_id": "text",
    "target": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "obj_modified_date": "2025-08-29T22:32:44.119Z",
    "error_code": "text",
    "error_desc": "text",
    "is_ok": false,
    "raw_request": "text",
    "raw_response": "text",
    "created_date": "2025-08-29T22:32:44.119Z",
    "updated_date": "2025-08-29T22:32:44.119Z"
  }
]

List Product Error Reports

get

Get list of product error reports

Authorizations
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
Responses
200

List of Product Error Reports

application/json
get
GET /api/v1/error_reports/product/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "action_content_type": 1,
    "action_object_id": 1,
    "action": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "target_content_type": 1,
    "target_object_id": "text",
    "target": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "obj_modified_date": "2025-08-29T22:32:44.119Z",
    "error_code": "text",
    "error_desc": "text",
    "is_ok": false,
    "raw_request": "text",
    "raw_response": "text",
    "created_date": "2025-08-29T22:32:44.119Z",
    "updated_date": "2025-08-29T22:32:44.119Z"
  }
]

Partial Update Error Report Action Object ID

patch

Partial update a specific Error Report by ID with Action Object ID

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
action_object_idintegerOptional
Responses
200

Success

application/json
patch
PATCH /api/v1/error_reports/{id}/update_action_object_id/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "action_object_id": 1
}
{
  "id": 1,
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-08-29T22:32:44.119Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text",
  "created_date": "2025-08-29T22:32:44.119Z",
  "updated_date": "2025-08-29T22:32:44.119Z"
}

Update Error Code

patch

Update error code of error report

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
error_codestringOptional
Responses
200

Success

application/json
patch
PATCH /api/v1/error_reports/{id}/update_error_code/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "error_code": "text"
}
{
  "id": 1,
  "action_content_type": 1,
  "action_object_id": 1,
  "action": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "target_content_type": 1,
  "target_object_id": "text",
  "target": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "obj_modified_date": "2025-08-29T22:32:44.119Z",
  "error_code": "text",
  "error_desc": "text",
  "is_ok": false,
  "raw_request": "text",
  "raw_response": "text",
  "created_date": "2025-08-29T22:32:44.119Z",
  "updated_date": "2025-08-29T22:32:44.119Z"
}
PreviousApplicationPermissionsNextMailTemplates

Was this helpful?