Deferred Session

A Deferred Session in Alfred is a mechanism designed for asynchronous file uploads, integral to the document processing workflow. It serves as a container or grouping for files that are uploaded at different times or from various sources, but are all part of a single processing task or Job.

Key Features

  • Asynchronous Uploads: Allows files to be uploaded independently and asynchronously, catering to varied upload schedules and sources.

  • Job Association: Files in a Deferred Session are eventually associated with a Job. The creation of a Job marks the closure of the Deferred Session.

  • Flexible File Management: Supports the addition of files over time, providing flexibility in how and when files are uploaded for a Job.

Create a new Deferred Session.

POST https://<env>.tagshelf.com/api/deferred/create

This endpoint initiates a new Deferred Session in Alfred. It is used when there's a need to start uploading files asynchronously and at different times for a future Job. The endpoint provides a session ID, which is used to group the uploaded files together until the associated Job is created.

Headers

Name
Type
Description

X-TagshelfAPI-Key

String

Application API Key

Authorization

String

Bearer <access_token> or amx <hmac_token>

{
    "session_id": "0f767925-b464-4ffa-b621-1a0aeacac256"
}

Retrieve details of a specific Deferred Session.

GET https://<env>.tagshelf.com/api/deferred/detail/:id

This endpoint provides detailed information about a Deferred Session, identified by its unique id. It's used to fetch information such as the list of files in the session, the status of each file upload, and other relevant metadata.

Path Parameters

Name
Type
Description

id*

UUID

Deferred Session ID

Headers

Name
Type
Description

X-TagshelfAPI-Key

String

Application API Key

Authorization

String

Bearer <access_token> or amx <hmac_token>

{
    "id": "0f767925-b464-4ffa-b621-1a0aeacad257",
    "creation_date": "2022-11-17T00:00:00.000",
    "update_date": "2022-11-17T00:00:00.000",
    "status": "open",
    "user_name": "SuperTagShelf",
    "company_id": "286e2ed0-3626-4faa-a745-8ebf3488fbd7",
    "job_id": null
}

Last updated