---
title: "GET /v1/report/getMetadata#reportId"
method: GET
path: "/v1/report/getMetadata#reportId"
---

# GET /v1/report/getMetadata#reportId

`GET /v1/report/getMetadata#reportId`

Get the metadata for a single report.

## Query parameters

- `reportId` string, required
- `reportVersion` integer

## Response `200`

Success

- GetReportMetadataResponse
  - `reportDetails` object — Report resource detail.
    - `id` string — Unique resource ID for the report resource.
    - `name` string — Name for the report resource.
    - `description` string — Description for the report resource.
    - `periodStart` string, date-time — Timestamp indicating the report resource effective start.
    - `periodEnd` string, date-time — Timestamp indicating the report resource effective end.
    - `createdAt` string, date-time — Timestamp indicating when the report resource was created.
    - `lastModifiedAt` string, date-time — Timestamp indicating when the report resource was last modified.
    - `deletedAt` string, date-time — Timestamp indicating when the report resource was deleted.
    - `state` 'PUBLISHED' | 'UNPUBLISHED' — Current state of the report resource
    - `arn` string — ARN for the report resource.
    - `series` string — Series for the report resource.
    - `category` string — Category for the report resource.
    - `companyName` string — Associated company name for the report resource.
    - `productName` string — Associated product name for the report resource.
    - `termArn` string — Unique resource ARN for term resource.
    - `version` integer — Version for the report resource.
    - `acceptanceType` 'PASSTHROUGH' | 'EXPLICIT' — Acceptance type for report.
    - `sequenceNumber` integer — Sequence number to enforce optimistic locking.
    - `uploadState` 'PROCESSING' | 'COMPLETE' | 'FAILED' | 'FAULT' — The current state of the document upload.
    - `statusMessage` string — The message associated with the current upload state.

## Other responses

- `480` — ResourceNotFoundException
- `481` — ThrottlingException
- `482` — AccessDeniedException
- `483` — InternalServerException
- `484` — ValidationException
- `485` — ServiceQuotaExceededException

---

[API](https://skmtc.net/aws/apis/artifact.md) · [All operations](https://skmtc.net/aws/apis/artifact/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/artifact/versions/7720117618ca/schema)