Get S3 object metadata

GET

/orgs/compliance_documents/s3_object/s3_object_metadata/v1/:org_compliance_document_s3_object_metadata_id

GET

/orgs/compliance_documents/s3_object/s3_object_metadata/v1/:org_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.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compliance_document_s3_object_metadata_id");
8 }
9 main();

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

Retrieves metadata for an organization compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (OrgComplianceDocumentS3ObjectMetadata1)

Authentication

AuthorizationBearer

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

Path parameters

org_compliance_document_s3_object_metadata_idstringRequired

Response

Successful Response

_idstring

org_compliance_document_idstring

schema_versioninteger

uploaded_at_timestampdatetime

uploaded_by_org_idstring

Must be a string starting with org_

uploaded_by_user_idstring

Must be a string starting with user_

blurhashstringOptional

content_typestringOptional

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

filenamestringOptional

Original filename of the uploaded file

s3_key_prefix"orgs/org_compliance_document_s3_object_metadata"Optional

Errors

422

S3object Get S3object Metadata V1request Unprocessable Entity Error