foliolib.folio.api.audit.AcquisitionEvents

class foliolib.folio.api.audit.AcquisitionEvents(tenant: str)

Bases: foliolib.folio.FolioApi

Acquisition Audit events API

API for retrieving events for acquisition changes

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

get_order(orderId, **kwargs)	Get list of order events by order_id
get_orderLine(orderLineId, **kwargs)	Get list of order_line events by order_line_id
get_piece(pieceId, **kwargs)	Get list of piece events by piece_id
get_statusChangeHistory_by_piece(pieceId, ...)	Get list of piece events which have unique status changes by piece_id

get_order(orderId: str, **kwargs)

Get list of order events by order_id

GET /audit-data/acquisition/order/{orderId}

Parameters

• orderId (str) –

• **kwargs (properties) – Keyword Arguments

Keyword Arguments

• sortBy (str) – (default=action_date) sorting by field: actionDate

• sortOrder (str) – (default=desc) sort order: asc or desc

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of orderAuditEvents",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "orderAuditEvents": {
      "description": "List of orderAuditEvents",
      "type": "array",
      "id": "orderAuditEventsList",
      "items": {
        "type": "object",
        "$ref": "order_audit_event.json"
      }
    },
    "totalItems": {
      "description": "total records",
      "type": "integer"
    }
  },
  "required": [
    "orderAuditEvents",
    "totalItems"
  ]
}

get_orderLine(orderLineId: str, **kwargs)

Get list of order_line events by order_line_id

GET /audit-data/acquisition/order-line/{orderLineId}

Parameters

• orderLineId (str) –

• **kwargs (properties) – Keyword Arguments

Keyword Arguments

• sortBy (str) – (default=action_date) sorting by field: actionDate

• sortOrder (str) – (default=desc) sort order: asc or desc

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of orderLineAuditEvents",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "orderLineAuditEvents": {
      "description": "List of orderLineAuditEvents",
      "type": "array",
      "id": "orderLineAuditEventsList",
      "items": {
        "type": "object",
        "$ref": "order_line_audit_event.json"
      }
    },
    "totalItems": {
      "description": "total records",
      "type": "integer"
    }
  },
  "required": [
    "orderLineAuditEvents",
    "totalItems"
  ]
}

get_piece(pieceId: str, **kwargs)

Get list of piece events by piece_id

GET /audit-data/acquisition/piece/{pieceId}

Parameters

• pieceId (str) –

• **kwargs (properties) – Keyword Arguments

Keyword Arguments

• sortBy (str) – (default=action_date) sorting by field: actionDate

• sortOrder (str) – (default=desc) sort order: asc or desc

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of pieceLineAuditEvents",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "pieceAuditEvents": {
      "description": "List of pieceAuditEvents",
      "type": "array",
      "id": "pieceAuditEventsList",
      "items": {
        "type": "object",
        "$ref": "piece_audit_event.json"
      }
    },
    "totalItems": {
      "description": "total records",
      "type": "integer"
    }
  },
  "required": [
    "pieceAuditEvents",
    "totalItems"
  ]
}

get_statusChangeHistory_by_piece(pieceId: str, **kwargs)

Get list of piece events which have unique status changes by piece_id

GET /audit-data/acquisition/piece/{pieceId}/status-change-history

Parameters

• pieceId (str) –

• **kwargs (properties) – Keyword Arguments

Keyword Arguments

• sortBy (str) – (default=action_date) sorting by field: actionDate

• sortOrder (str) – (default=desc) sort order: asc or desc

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of pieceLineAuditEvents",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "pieceAuditEvents": {
      "description": "List of pieceAuditEvents",
      "type": "array",
      "id": "pieceAuditEventsList",
      "items": {
        "type": "object",
        "$ref": "piece_audit_event.json"
      }
    },
    "totalItems": {
      "description": "total records",
      "type": "integer"
    }
  },
  "required": [
    "pieceAuditEvents",
    "totalItems"
  ]
}