> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IPublisherDocumentDefinitionV1

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/publisher/v1/document.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Payload for creating or updating a document.

**Signature:**

```typescript
export interface IPublisherDocumentDefinitionV1 extends IPublisherDocumentBaseV1 
```
**Extends:** [IPublisherDocumentBaseV1](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipublisherdocumentbasev1/index.md)

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [ref?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipublisherdocumentdefinitionv1/index.md#ipublisherdocumentdefinitionv1ref) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(ALPHA)_** _(Optional)_ Present when updating an existing document. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipublisherdocumentdefinitionv1/index.md#ipublisherdocumentdefinitionv1type) |  | "report" | **_(ALPHA)_** |

## Property details

### IPublisherDocumentDefinitionV1.ref

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Present when updating an existing document.

**Signature:**

```typescript
ref?: ObjRef;
```

### IPublisherDocumentDefinitionV1.type

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
type: "report";
```