Metadata Provider (v1.0)

http://localhost

Table of contents

Metadata Provider API

API for accessing metadata

/metadata-provider

GET /metadata-provider/jobExecutions

GET /metadata-provider/jobExecutions
Query Parameters
  • query: (string)

    A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

    with valid searchable fields

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    status=RUNNING
    
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10

Response 200

Body

Media type: application/json

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

GET /metadata-provider/logs/{jobExecutionId}

GET /metadata-provider/logs/{jobExecutionId}
URI Parameters
  • jobExecutionId: required (string)

Response 200

Body

Media type: application/json

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

GET /metadata-provider/journalRecords/{jobExecutionId}

get journal records by job execution id

GET /metadata-provider/journalRecords/{jobExecutionId}
URI Parameters
  • jobExecutionId: required (string)
Query Parameters
  • sortBy: (string)

    sort criteria

    Example:

    source_record_order, action_type, error
  • order: required (one of asc, desc - default: asc)

    sort direction

    Example:

    desc

Response 200

Body

Media type: application/json

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

Response 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

GET /metadata-provider/jobLogEntries/{jobExecutionId}

get journal records by job execution id

GET /metadata-provider/jobLogEntries/{jobExecutionId}
URI Parameters
  • jobExecutionId: required (string)
Query Parameters
  • sortBy: (string - default: source_record_order)

    sorting by field: source_record_order, title, source_record_action_status, instance_action_status, holdings_action_status, item_action_status, order_action_status, invoice_action_status, error

    Example:

    source_record_order
  • order: (one of asc, desc - default: asc)

    sorting direction

    Example:

    desc
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10

Response 200

Body

Media type: application/json

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

GET /metadata-provider/jobLogEntries/{jobExecutionId}/records/{recordId}

get record processing log dto by job execution id and record id (to get EDIFACT import log data a journal record id is expected)

GET /metadata-provider/jobLogEntries/{jobExecutionId}/records/{recordId}
URI Parameters
  • jobExecutionId: required (string)
  • recordId: required (string)

Response 200

Body

Media type: application/json

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

Response 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found