Skip to content

Get customer AdjunctQueue #1157

@donaldgray

Description

@donaldgray

Implement API endpoint GET /customers/{customer}/adjunctQueue. This is the equivalent of /customers/{customer}/queue and works in an identical way, with the difference being this returns a CustomerAdjunctQueue.

See https://dlcs.github.io/public-docs/api-doc/queues/#adjunct-queue

Example response:

{
    "@context": "https://dlcs.github.io/vocab/context/future.json",
    "@id": "https://api.dlcs.example/customers/2/adjunctQueue",
    "@type": "vocab:CustomerAdjunctQueue",
    "size": 170,
    "batchesWaiting": 0,
    "adjunctsWaiting": 0,
    "batches": "https://api.dlcs.example/customers/2/adjunctQueue/batches",
    "active": "https://api.dlcs.example/customers/2/adjunctQueue/active",
    "recent": "https://api.dlcs.example/customers/2/adjunctQueue/recent"
}
  • batches, active and recent links show correct links (note that these will 404 until implemented)
  • size - Number of total adjuncts in your queue, across all batches. This number decreases as the platform processes your adjuncts.
  • batchesWaiting - Number of adjunct batches that are waiting to be processed. These are batches that have been submitted but are not yet the platform has not yet started working on them.
  • adjunctsWaiting - Number of adjuncts waiting to be processed. These are adjuncts that have been submitted but the platform has not yet started working on them. This differs from in that it excludes adjuncts currently being processed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    APIhttps://dlcs-book.readthedocs.io/en/latest/adjunctsTickets that relate to "adjuncts" functionality to store additional linked files to an asset.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions