Skip to main content
GET
/
local-file-groups
/
{id}
Python
import os
from qaip import Qaip

client = Qaip(
    api_key=os.environ.get("QAIP_API_KEY"),  # This is the default and can be omitted
)
local_file_group = client.local_file_groups.retrieve(
    "id",
)
print(local_file_group.id)
{
  "id": "<string>",
  "name": "<string>",
  "upload_time": 123,
  "creation_time": 123,
  "start_time": 123,
  "end_time": 123,
  "error": {
    "title": "<string>",
    "message": "<string>"
  },
  "metadata": {
    "records": [
      {
        "key": "<string>",
        "val": "<string>"
      }
    ]
  },
  "chunk_metadata_keys": [
    {
      "key": "<string>"
    }
  ],
  "chunk_metadatas_count": 123
}

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

id
string
required

Response

Successful retrieval of local file group

id
string
required

Local file group ID

name
string
required

Local file group name

status
enum<string>
required

Job status

Available options:
unknown,
queued,
not_started,
managed,
starting,
started,
success,
failure,
canceling,
canceled,
deleting,
delete_job_failure
upload_time
integer<int64>

Upload time (Unix timestamp in seconds)

creation_time
integer<int64>

Creation time (Unix timestamp in seconds)

start_time
integer<int64>

Start time (Unix timestamp in seconds)

end_time
integer<int64>

End time (Unix timestamp in seconds)

error
object
metadata
object

(reserved for future use) Additional metadata for the local file group

chunk_metadata_keys
object[]

Chunk metadata key configurations

chunk_metadatas_count
integer<int64>

Number of chunk metadata records extracted for this local file group