Get S3 object metadata

GET

/shipping/drivers/compliance_documents/s3_object/s3_object_metadata/v1/:driver_compliance_document_s3_object_metadata_id

GET

/shipping/drivers/compliance_documents/s3_object/s3_object_metadata/v1/:driver_compliance_document_s3_object_metadata_id

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.shipping.drivers.complianceDocuments.s3Object.getS3ObjectMetadataV1("driver_compliance_document_s3_object_metadata_id");
8 }
9 main();

1 {
2   "schema_version": 1,
3   "_id": "_id",
4   "driver_compliance_document_id": "driver_compliance_document_id",
5   "uploaded_at_timestamp": "2024-01-15T09:30:00Z",
6   "uploaded_by_user_id": "uploaded_by_user_id",
7   "uploaded_by_org_id": "uploaded_by_org_id",
8   "s3_key_prefix": "shipping/driver_compliance_document_s3_object_metadata",
9   "blurhash": "blurhash",
10   "content_type": "content_type",
11   "filename": "filename"
12 }

Retrieves metadata for a driver compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (DriverComplianceDocumentS3ObjectMetadata1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

driver_compliance_document_s3_object_metadata_idstringRequired

Response

Successful Response

schema_versioninteger

_idstring

driver_compliance_document_idstring

uploaded_at_timestampdatetime

uploaded_by_user_idstring

Must be a string starting with user_

uploaded_by_org_idstring

Must be a string starting with org_

s3_key_prefix"shipping/driver_compliance_document_s3_object_metadata"

blurhashstring

content_typestring

MIME type of the uploaded file (e.g., ‘image/jpeg’, ‘application/pdf’)

filenamestring

Original filename of the uploaded file

Errors

422

S3object Get S3object Metadata V1request Unprocessable Entity Error